Verified Commit 98fb1578 authored by Hueser, Christian (FWCC) - 138593's avatar Hueser, Christian (FWCC) - 138593
Browse files

Adapt file README to incorporate review suggestions

* Adapt file README to make it more readable.
* Put text into bullet point list.
* Fix grammar mistake.
parent 6356a837
Pipeline #91849 passed with stage
in 24 seconds
......@@ -109,7 +109,7 @@ Please put your analysis scripts into a sub-folder called _scripts_.
The preprocessing script _preprocess.py_ is expected in the root folder of the
project.
Make sure that the file _meta.yml_ is put into sub-folder _metadata_.
Finally, copy the CSV data file of your survey into a central location like a
Finally, copy the CSV data file of your survey to a central location like a
_data_ sub-folder and tell the program the path to that data file on the
command line when running the survey analysis.
......@@ -215,31 +215,29 @@ SCRIPT_FOLDER: scripts
SCRIPT_NAMES: []
```
First, you need to specify the name of the _id_ column in the CSV data file.
Second, each analysis needs metadata about the questions asked in the
survey and answers that participants may give.
This metadata file is by default located in a folder called _metadata_
and named _meta.yml_.
Third, you may specify the output folder which is named _output_ by default.
Fourth, you may prefer a specific output format like _PDF_, _PNG_, _SVG_ or
_SCREEN_.
The default value is _SCREEN_.
Note: Be aware that other output formats like text or markdown files may be
created, which depends largely upon the implementation of the analysis scripts.
Fifth, you might want to tell the program where to find the preprocessing file
_preprocess.py_ that preprocesses and filters your survey data according to
specific rules.
Sixth, you may specify the folder which contains the analysis scripts, which
is the _scripts_ folder by default.
Finally, you may select a subset of the analysis scripts available as a list
that ought to be executed.
This list is empty by default, which means, all scripts are executed.
- With `ID_COLUMN_NAME` you may want to specify the name of the _id_ column in
the CSV data file.
- Each analysis needs metadata about the questions asked in the survey and
answers that participants may give.
Setting `METADATA` specifies the location of the Metadata file which is by
default located in a folder called _metadata_ and named _meta.yml_.
- You may specify the output folder by setting `OUTPUT_FOLDER` which is named
_output_ by default.
- You may prefer a specific output format like _PDF_, _PNG_, _SVG_ or
_SCREEN_ which you may select via `OUTPUT_FORMAT`.
The default value is _SCREEN_.
Note: Be aware that other output formats like text or markdown files may be
created, which depends largely upon the implementation of the analysis
scripts.
- You might want to tell the program where to find the preprocessing file
_preprocess.py_ that preprocesses and filters your survey data according to
specific rules.
You can do so by setting `PREPROCESSING_FILENAME`.
- You may specify the folder which contains the analysis scripts with setting
`SCRIPT_FOLDER`, which is the _scripts_ folder by default.
- With `SCRIPT_NAMES` you may select a subset of the analysis scripts available
as a list that ought to be executed.
This list is empty by default, which means, all scripts are executed.
Additional to the configuration file there are two more files created:
......@@ -338,4 +336,4 @@ This work is licensed under the following license(s):
Please see the individual files for more accurate information.
> **Hint:** We provided the copyright and license information in accordance to the [REUSE Specification 3.0](https://reuse.software/spec/).
\ No newline at end of file
> **Hint:** We provided the copyright and license information in accordance to the [REUSE Specification 3.0](https://reuse.software/spec/).
Markdown is supported
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