Skip to content

Commit

Permalink
Update usage.md (#195)
Browse files Browse the repository at this point in the history
* Update usage.md

add info on using --allow-non-numeric-obs-values=true

* Update usage.md

nit

* Update usage.md

nit
  • Loading branch information
lucy-kind authored Jan 3, 2023
1 parent 60f3ab0 commit 7874392
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ To run the tool in lint mode, use:
```bash
dc-import lint <list of mcf files>
```

Note that if you are importing a dataset where non-numerical StatVar Observations are expected (for example, statType is measurementResult and, therefore, the SVObs values are references), set `--allow-non-numeric-obs-values=true` in the command line invocation.

For example, we can use `lint` to perform syntax validation on [a test MCF included in this repository](tool/src/test/resources/org/datacommons/tool/lint/mcfonly/input/McfOnly.mcf) at path `tool/src/test/resources/org/datacommons/tool/lint/mcfonly/input/McfOnly.mcf` relative to the base of this repo like so:
```bash
Expand All @@ -75,6 +77,8 @@ To run the tool in genmcf mode, use:

Optionally, schema file(s) may also be passed. This is required to resolve references to newly introduced schema nodes.

Similar to when using `lint` mode above, if you are importing a dataset where non-numerical StatVar Observations are expected (for example, statType is measurementResult and, therefore, the SVObs values are references), set `--allow-non-numeric-obs-values=true` in the command line invocation.

For example, we can use `genmcf` to perform validations, and generate instance MCF from test files about COVID-19 cases in India.

These test files are:
Expand Down

0 comments on commit 7874392

Please sign in to comment.