Commit 2b710763 authored by Hans van den Heuvel's avatar Hans van den Heuvel
Browse files

Updated documentation; added file to Example

parent 8a51bdf7
......@@ -78,7 +78,7 @@ dataset.add(
short_argument='-g',
help='The (input) food composition file - '
+ 'format: xlsx (Excel), file not required.',
default_name='FoodComposition.xlsx',
default_name='FoodCompositions.xlsx',
necessary=False,
default_dir='Input',
direction='Input',
......
......@@ -11,6 +11,16 @@ pip install pandas xlrd tabulate openpyxl requests
```
python.exe convert.py -x -v
```
Again in trial mode, now using all input files from the Example directory
```
python.exe convert.py -x -v -s -g
```
### Run the script with the default names
In the example here also a substance conversion (-s) and FoodTranslation (-g) is done.
```
python.exe convert.py -s -g -v
```
### Run the script with specific input files
```
......@@ -33,6 +43,8 @@ These are the input and output files of the script. All names are defaults, and
* The processing translation input file, [ProcTypeTranslations.csv](ProcTypeTranslations.csv)
* The food translation input file, [FoodTranslations.csv](FoodTranslations.csv)
* The processing types input file to augment info in the report, [ProcessingTypes.csv](ProcessingTypes.csv) (not used in any data processing)
* An optional substances sheet (-s), to augment the output with the ``CASNumber``.
* An optional FoodComposition file (-g), to augment the output with A-codes.
* Output files:
* The goal of this script, the file [ProcessingTypes.csv](ProcessingTypes.csv) with the new MCRA ProcessingTypes. By default this file will be contained in a zip file [ProcessingFactors.zip](ProcessingFactors.zip)
* A small markdown report is also created, usally called [Report.md](Report.md), but within the zip file is called Readme.md.
......@@ -108,7 +120,7 @@ optional arguments:
-g [FOOD_COMPOSITION_FILE], --food_composition_file [FOOD_COMPOSITION_FILE]
The (input) food composition file - format: xlsx
(Excel), file not required. (default:
FoodComposition.xlsx)
FoodCompositions.xlsx)
-o [PROCESSING_FACTOR_FILE], --processing_factor_file [PROCESSING_FACTOR_FILE]
The (output) processing factor file - format: csv
(Comma Seperated). (default: ProcessingFactors.zip)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment