Report gen doc - #10
Conversation
| -x, --x_axes_str - Create graphs with x axes being the columns containing these strings ( Default: First column of first file ) | ||
| --plot_col - Only plot the columns with these names while plotting across csv files ( Default: All columns ) | ||
| -e, --extension - Specify the extension of the graphs ( Default: svg ) | ||
| -c, --categories - Plot by category ( Default: no category ) |
There was a problem hiding this comment.
What is the category here?
| -o, --out_dir - Output directory for the graphs ( Default: ./ ) | ||
| -x, --x_axes_str - Create graphs with x axes being the columns containing these strings ( Default: First column of first file ) | ||
| --plot_col - Only plot the columns with these names while plotting across csv files ( Default: All columns ) | ||
| -e, --extension - Specify the extension of the graphs ( Default: svg ) |
There was a problem hiding this comment.
This would be better named --format. But I see that it really is the extension and the format is probably determined by the extension. Better description would be:
Store graphs in files with the given extension(s). The file format is given by the extension.
| ## Using graph generator (graphgen.py) | ||
|
|
||
| ### Arguments | ||
| -f, --csv_file - CSV file(s) to process ( Required ) |
There was a problem hiding this comment.
It would be better to put here the output of graphgen.py --help. It's better formatted and gives more information about the arguments. To show the default values, in the --help output, look at https://stackoverflow.com/a/12151325/902448.
|
|
||
| The required packages can be installed with the command: | ||
|
|
||
| pip3 install pandas cufflinks scipy orca |
There was a problem hiding this comment.
It seems cufflinks is no really used in the source code, recordclass as well.
|
|
||
| ### Basic functionality | ||
|
|
||
| Read supplied csv files, create graphs from the columns they have in common, and export them to the specified format. As default, the x axis is the first column in the first file. |
There was a problem hiding this comment.
I'd start by describing the use case with a single CSV file. Multiple CSV files are a bit more complex so it should be after the simplest use case.
|
|
||
| #### Category plot by file | ||
|
|
||
| For each csv file, selects columns containing given strings and plots them with a common name on the y axis. E.g. the category name can be Frequency, and we may search for the string "freq" to group those columns together. |
|
|
||
| #### Custom x axes | ||
|
|
||
| With this argument you can select source data for x axes. |
|
|
||
|
|
||
| ## Using htmlgen.py | ||
|
|
There was a problem hiding this comment.
Repeat what is htmlgen good for.
|
|
||
| ### Functionality | ||
|
|
||
| Creates a html report from the graphs found in the figures directory. The report has 3 types of pages: the main page summarizing the individual tests by category, the pages for the individual tests themselves, and a page for comparing sensor outputs for all tests. |
There was a problem hiding this comment.
It's not clear what you mean by "sensor". So far you talked only about abstract CSV files with any values in them. And even in case of thermobench, not all columns are sensor values.
|
|
||
| Creates a html report from the graphs found in the figures directory. The report has 3 types of pages: the main page summarizing the individual tests by category, the pages for the individual tests themselves, and a page for comparing sensor outputs for all tests. | ||
|
|
||
| All html pages are stored in a subdirectory of the output dir called htmls. An initial page called main.html is also stored in the output dir, which is just a redirect to the main page in the htmls directory. |
There was a problem hiding this comment.
Why is not main.html called index.html. This is usually the default file looked up by web servers.
|
@rozsatib See my comments above. |
1 participant
No description provided.