Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
urmi-21 committed Jan 13, 2021
1 parent e4f2c81 commit 84d0a5f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/tutorial/diagnostic.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
pyrpipe_diagnostic
-------------------

The pyrpipe_diagnostic command allows users to easily examine pyrpipe logs.
It provides several options.

1. report: This command can generate a summary or detailed report of the analysis.
2. shell: This command creates a bash file containing all the commands executed via pyrpipe
3. benchmark: This command can generate benchmarks to compare walltimes of the different commands in the pipeline.
4. multiqc: This command uses the `MultiQC <https://multiqc.info/>`_ tool to generate a report using pyrpipe logs and other logs geenrated by the pipeline.

0 comments on commit 84d0a5f

Please sign in to comment.