1 ConE report action

     2 ==================

     3 

     4 The report action can be used to create a report based on report generation

     5 data created beforehand by the generate action using the switch ``--report-data-output``.

     6 The report can be generated based on a single data file, or by merging multiple files.

     7 

     8 Examples

     9 --------

    10 

    11 **Creating a report from a single data file**::

    12 

    13     cone report --input-data report.dat

    14 

    15 This would generate a report based on the data in ``report.dat`` into ``report.html``

    16 in the current directory.

    17 

    18 **Creating a report from multiple files**::

    19 

    20     cone report --input-data rofs3.dat --input-data uda.dat --template template.html

    21 

    22 This would generate a report based the data from two generation runs, one for ROFS3 data

    23 and one for UDA data. The used template is overridden using ``--template``.

    24 

    25 Options list

    26 ------------

    27   --version             show program's version number and exit

    28   -h, --help            show this help message and exit

    29   --print-settings      Print all the default settings from the current

    30                         setting container.

    31   --print-supported-impls

    32                         Print all supported ImplML XML namespaces and file

    33                         extension.

    34   -v LEVEL, --verbose=LEVEL

    35                         Print error, warning and information on system out.

    36                         Possible choices: Default is 3.

    37                         NONE (all)    0

    38                         CRITICAL      1

    39                         ERROR         2

    40                         WARNING       3

    41                         INFO          4

    42                         DEBUG         5

    43   --log-file=FILE       Location of the used log file. Default is 'cone.log'

    44   -p STORAGE, --project=STORAGE

    45                         defines the location of current project. Default is

    46                         the current working directory.

    47 

    48   Report options:

    49     The report function generates a report using previously generated

    50     intermediary report data as input.

    51 

    52     -i FILE, --input-data=FILE

    53                         Defines an input file for report generation. If

    54                         specified more than once, the data of all specified

    55                         report data files is merged.

    56     -r FILE, --report=FILE

    57                         Generates a report about settings that are properly

    58                         generated.Example -r report.html.

    59     -t FILE, --template=FILE

    60                         Template used in report generation.Example -t

    61                         report_template.html.