Skip to content

Commit 5c19085

Browse files
committed
Add preflight to the readme.
1 parent bc35e68 commit 5c19085

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,32 @@ pip install physionet
1010

1111
## Usage
1212

13+
### PhysioNet "Preflight"
14+
15+
Validate your dataset before submission to PhysioNet:
16+
17+
```bash
18+
# Validate a dataset
19+
physionet validate /path/to/dataset
20+
21+
# Run specific checks only
22+
physionet validate /path/to/dataset --checks filesystem,privacy
23+
24+
# Disable sampling for complete validation (slower)
25+
physionet validate /path/to/dataset --no-sampling
26+
```
27+
28+
The validator checks for:
29+
30+
- File naming issues (spaces, special characters, long names)
31+
- Proprietary formats (suggests open alternatives)
32+
- Missing documentation (README.md)
33+
- CSV integrity (structure, encoding, duplicate columns)
34+
- Data quality (missing values, out-of-range data)
35+
- Privacy concerns (PHI patterns, sensitive files)
36+
37+
A validation report (PHYSIONET_REPORT.md) is automatically saved in your dataset folder.
38+
1339
### API Client
1440

1541
Interact with the PhysioNet API to explore and search published projects:

0 commit comments

Comments
 (0)