Skip to content

Commit

Permalink
Updates to documentation for using 'extra_outputs.tsv' files in QC re…
Browse files Browse the repository at this point in the history
…porting.
  • Loading branch information
pjbriggs committed Jan 17, 2024
1 parent 514dd65 commit 47aabd6
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion docs/source/using/run_qc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,14 +200,38 @@ include, with the minimal specification being:

::

FILE DESCRIPTION
FILE_PATH DESCRIPTION

For example:

::

extra_metrics/metrics.html Manually generated QC metrics

If the output has additional associated files or directories
(for example, the main output is an index file that then
links to other files) then these can be included as a
comma-separated list via an optional third field in the TSV
file:

::

FILE_PATH DESCRIPTION PATH1[,PATH2[,...]]

For example:

::

more_metrics/index.html More QC metrics more_metrics/results

The additional files will then be included in the ZIP archive.

.. note::

If any additional "files" are actually subdirectories
then the contents of those directories will also be
included automatically.

------------------
Additional options
------------------
Expand Down

0 comments on commit 47aabd6

Please sign in to comment.