search

D4H-VA / smartva-dhis2

Verbal Autopsy data integration into DHIS2
https://smartva-dhis2.readthedocs.io
MIT License
1 stars 3 forks source link

Update documentation for SmartVA options #8

Closed rileyhazard closed 6 years ago

rileyhazard commented 6 years ago

You can specify a number of options before running SmartVA that are relevant to country implementation. The defaults are fine for some countries, but others will need to amend them (e.g. malaria endemic countries). Instructions to modify these options should be included in the documentation.

freetext, figures, version, legacy-format, and help are probably not relevant for these purposes.

Note: country text is given as an ISO Alpha-3 code (three letter abbreviation)

More info here: http://www.healthdata.org/sites/default/files/files/Tools/SmartVA_Help.pdf

Usage: smartva [OPTIONS] INPUT OUTPUT

Options:
  --country TEXT                  Data origin country abbreviation. "LIST"
                                  displays all. Default is "Unknown".
  --hiv BOOLEAN                   Data is from an HIV region. Default is True.
  --malaria BOOLEAN               Data is from a Malaria region. Default is
                                  True.
  --hce BOOLEAN                   Use Health Care Experience (HCE) variables.
                                  Default is True.
  --freetext BOOLEAN              Use "free text" variables. Default is True.
  --figures BOOLEAN               Generate charts and figures output. Default
                                  is True.
  --language [english|chinese|spanish]
                                  Language used for output files.
  --version                       Show the version and exit.
  --legacy-format                 Output files in a format that matches
                                  SmartVA v1.2
  --help                          Show this message and exit.