Skip to content

Commit e7e5959

Browse files
committed
saving logs
1 parent 45255c9 commit e7e5959

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

src/data_validation/README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,36 @@ We use `linkml-validate` to check whether data files conform to their schema def
2222

2323
### 1. Validate `study.csv` against `Study` class
2424
```bash
25-
linkml-validate -s src/linkml/include_schema.yaml -C study toy_data/initial/raw_data/study.csv
25+
linkml-validate -s src/linkml/include_schema.yaml -C Study src/data/input/study.csv
2626
```
2727
### 2. Validate `participant.csv` against `Participant` class
2828
```bash
29-
linkml-validate -s src/linkml/include_schema.yaml -C subject toy_data/initial/raw_data/subject.csv
29+
linkml-validate -s src/linkml/include_schema.yaml -C Participant src/data/input/participant.csv
3030
```
3131
### 3. Validate `condition.csv` against `Condition` class
3232
```bash
33-
linkml-validate -s src/linkml/include_schema.yaml -C demographics toy_data/initial/raw_data/demographics.csv
33+
linkml-validate -s src/linkml/include_schema.yaml -C Condition src/data/input/condition.csv
3434
```
3535
### 4. Validate `biospecimen.csv` against `Biospecimen` class
3636
```bash
37-
linkml-validate -s src/linkml/include_schema.yaml -C sample toy_data/initial/raw_data/sample.csv
37+
linkml-validate -s src/linkml/include_schema.yaml -C Biospecimen src/data/input/biospecimen.csv
3838
```
3939
### 5. Validate `datafile.csv` against `DataFile` class
4040
```bash
41-
linkml-validate -s src/linkml/include_schema.yaml -C lab_results toy_data/initial/raw_data/lab_results.csv
41+
linkml-validate -s src/linkml/include_schema.yaml -C DataFile src/data/input/datafile.csv
4242
```
4343

4444
- **More Info**: [linkml-validate CLI](https://linkml.io/linkml/cli/validate.html)
4545

46+
### 📤 Saving Validation Logs
47+
48+
To save validation output to a file (e.g., for documentation or reporting), redirect the output of `linkml-validate`:
49+
50+
```bash
51+
linkml-validate -s src/linkml/include_schema.yaml -C Study src/data/input/study.csv > src/data/output/validation-report.md
52+
```
53+
You can change the extension to .csv, .txt, or .json based on your preferred format.
54+
4655
📌 Notes
4756

4857
- Ensure all required fields are present in your CSV files.

0 commit comments

Comments
 (0)