diff --git a/docs/vlmd/extract/csvdd.md b/docs/vlmd/extract/csvdd.md new file mode 100644 index 0000000..7988541 --- /dev/null +++ b/docs/vlmd/extract/csvdd.md @@ -0,0 +1,14 @@ +# `csv` (Minimal) Data Dictionary + + +A minimal data dictionary in a csv (or tsv file). For example, may have `name`, `type`, and description and then this adds the rest of the fields. + +> Also maps a few common data types (such as char, character,text to 'string' and 'float' to 'number'.) + +## Run the `vlmd` command + +=== "CLI" + +```bash +vlmd extract --inputtype csv-data-dict data/minimal-csv-dd.csv +``` \ No newline at end of file diff --git a/docs/vlmd/extract/index.md b/docs/vlmd/extract/index.md index 0633cd7..30cc971 100644 --- a/docs/vlmd/extract/index.md +++ b/docs/vlmd/extract/index.md @@ -4,7 +4,7 @@ The healdata-utils variable-level metadata (vlmd) tool inputs a variety of diffe !!! warning - Currently the python subcommand is `convert` but will be changed to `extract_to_vlmd` to be + Currently the python subcommand is `convert_to_vlmd` but will be changed to `extract_to_vlmd` to be consistent with CLI. `extract` was chosen to better reflect the functionality. @@ -50,6 +50,7 @@ This section provides the specific syntax for running each of the supported type Extract variable level metadata from your data: - [CSV datasets](./csvdata.md) +- [CSV (minimal) data dictionary](./csvdd.md) - [SPSS datasets](./spss.md) - [SAS datasets](./sas.md) - [Stata datasets](./stata.md)