Skip to content

Commit fb28b30

Browse files
dpryan79dpryan79
committed
Add a readthedocs page for plotEnrichment, fixes #408 
1 parent bdee5c1 commit fb28b30

File tree

1 file changed

+35
-31
lines changed

1 file changed

+35
-31
lines changed

‎docs/content/list_of_tools.rst‎

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,39 @@ The tools
1414
.. contents::
1515
:local:
1616

17-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
18-
| tool | type | input files | main output file(s) | application |
19-
+================================+==================+===================================+============================================+===================================================================================+
20-
|:doc:`tools/multiBamSummary` | data integration | 2 or more BAM | interval-based table of values | perform cross-sample analyses of read counts --> plotCorrelation, plotPCA |
21-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
22-
|:doc:`tools/multiBigwigSummary` | data integration | 2 or more bigWig | interval-based table of values | perform cross-sample analyses of genome-wide scores --> plotCorrelation, plotPCA |
23-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
24-
|:doc:`tools/plotCorrelation` | visualization | bam/multiBigwigSummary output | clustered heatmap | visualize the Pearson/Spearman correlation |
25-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
26-
|:doc:`tools/plotPCA` | visualization | bam/multiBigwigSummary output | 2 PCA plots | visualize the principal component analysis |
27-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
28-
|:doc:`tools/plotFingerprint` | QC | 2 BAM | 1 diagnostic plot | assess enrichment strength of a ChIP sample |
29-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
30-
|:doc:`tools/computeGCBias` | QC | 1 BAM | 2 diagnostic plots | calculate the exp. and obs. GC distribution of reads |
31-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
32-
|:doc:`tools/correctGCBias` | QC | 1 BAM, output from computeGCbias | 1 GC-corrected BAM | obtain a BAM file with reads distributed according to the genome’s GC content |
33-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
34-
|:doc:`tools/bamCoverage` | normalization | BAM | bedGraph or bigWig | obtain the normalized read coverage of a single BAM file |
35-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
36-
|:doc:`tools/bamCompare` | normalization | 2 BAM | bedGraph or bigWig | normalize 2 files to each other (e.g. log2ratio, difference) |
37-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
38-
|:doc:`tools/computeMatrix` | data integration | 1 or more bigWig, 1 or more BED | zipped file for plotHeatmap or plotProfile | compute the values needed for heatmaps and summary plots |
39-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
40-
|:doc:`tools/plotHeatmap` | visualization | computeMatrix output | heatmap of read coverages | visualize the read coverages for genomic regions |
41-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
42-
|:doc:`tools/plotProfile` | visualization | computeMatrix output | summary plot (“meta-profile”) | visualize the average read coverages over a group of genomic regions |
43-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
44-
|:doc:`tools/plotCoverage` | visualization | 1 or more bam | 2 diagnostic plots | visualize the average read coverages over sampled genomic positions |
45-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
46-
|:doc:`tools/bamPEFragmentSize` | information | 1 BAM | text with paired-end fragment length | obtain the average fragment length from paired ends |
47-
+--------------------------------+------------------+-----------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
17+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
18+
| tool | type | input files | main output file(s) | application |
19+
+================================+==================+=====================================+============================================+===================================================================================+
20+
|:doc:`tools/multiBamSummary` | data integration | 2 or more BAM | interval-based table of values | perform cross-sample analyses of read counts --> plotCorrelation, plotPCA |
21+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
22+
|:doc:`tools/multiBigwigSummary` | data integration | 2 or more bigWig | interval-based table of values | perform cross-sample analyses of genome-wide scores --> plotCorrelation, plotPCA |
23+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
24+
|:doc:`tools/plotCorrelation` | visualization | bam/multiBigwigSummary output | clustered heatmap | visualize the Pearson/Spearman correlation |
25+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
26+
|:doc:`tools/plotPCA` | visualization | bam/multiBigwigSummary output | 2 PCA plots | visualize the principal component analysis |
27+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
28+
|:doc:`tools/plotFingerprint` | QC | 2 BAM | 1 diagnostic plot | assess enrichment strength of a ChIP sample |
29+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
30+
|:doc:`tools/computeGCBias` | QC | 1 BAM | 2 diagnostic plots | calculate the exp. and obs. GC distribution of reads |
31+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
32+
|:doc:`tools/correctGCBias` | QC | 1 BAM, output from computeGCbias | 1 GC-corrected BAM | obtain a BAM file with reads distributed according to the genome’s GC content |
33+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
34+
|:doc:`tools/bamCoverage` | normalization | BAM | bedGraph or bigWig | obtain the normalized read coverage of a single BAM file |
35+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
36+
|:doc:`tools/bamCompare` | normalization | 2 BAM | bedGraph or bigWig | normalize 2 files to each other (e.g. log2ratio, difference) |
37+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
38+
|:doc:`tools/computeMatrix` | data integration | 1 or more bigWig, 1 or more BED | zipped file for plotHeatmap or plotProfile | compute the values needed for heatmaps and summary plots |
39+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
40+
|:doc:`tools/plotHeatmap` | visualization | computeMatrix output | heatmap of read coverages | visualize the read coverages for genomic regions |
41+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
42+
|:doc:`tools/plotProfile` | visualization | computeMatrix output | summary plot (“meta-profile”) | visualize the average read coverages over a group of genomic regions |
43+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
44+
|:doc:`tools/plotCoverage` | visualization | 1 or more BAM | 2 diagnostic plots | visualize the average read coverages over sampled genomic positions |
45+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
46+
|:doc:`tools/bamPEFragmentSize` | information | 1 BAM | text with paired-end fragment length | obtain the average fragment length from paired ends |
47+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
48+
|:doc:`tools/plotEnrichment` | visualization | 1 or more BAM and 1 or more BED/GTF | A diagnostic plot | plots the fraction of alignments overlapping the given features |
49+
+--------------------------------+------------------+-------------------------------------+--------------------------------------------+-----------------------------------------------------------------------------------+
4850

4951
General principles
5052
^^^^^^^^^^^^^^^^^^
@@ -144,3 +146,5 @@ Heatmaps and summary plots
144146
""""""""""""""""""""""""
145147
:doc:`tools/plotProfile`
146148
""""""""""""""""""""""""
149+
:doc:`tools/plotEnrichment`
150+
"""""""""""""""""""""""""""

0 commit comments

Comments
 (0)