Skip to content

Commit

Permalink
Add csv data dict extract to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mbkranz committed Sep 11, 2023
1 parent 3bc1cf2 commit 06ebc6b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/vlmd/extract/csvdd.md
Original file line number Diff line number Diff line change
@@ -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
```
3 changes: 2 additions & 1 deletion docs/vlmd/extract/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 06ebc6b

Please sign in to comment.