Skip to content

Commit

Permalink
add route description links
Browse files Browse the repository at this point in the history
  • Loading branch information
igordot authored May 24, 2017
1 parent 5e918bc commit 763c6e5
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,29 +56,31 @@ Routes are different analysis workflows.
Generic routes are sample-centric (same analysis is performed for each sample).
Available routes:

* `rna-star`: RNA-seq using STAR. Generates BAMs, normalized bigWigs, counts matrix, and various QC metrics.
* `rna-rsem`: RNA-seq using RSEM. Generates FPKM/TPM/counts matrix and various QC metrics.
* `rna-snv`: RNA-seq variant detection. Generates BAMs, VCFs, and various QC metrics.
* `wgbs`: WGBS using Bismark.
* `rrbs`: RRBS using Bismark.
* `wes`: Whole genome/exome/targeted variant detection. Generates BAMs, VCFs, and various QC metrics.
* `atac`: ATAC-seq. Generates BAMs, bigWigs, peaks, nucleosome positions, and various QC metrics.
* `species`: Species/metagenomics/contamination analysis.
* [rna-star](https://github.com/igordot/sns/blob/master/routes/rna-star.md): RNA-seq using STAR. Generates BAMs, normalized bigWigs, counts matrix, and various QC metrics.
* [rna-rsem](https://github.com/igordot/sns/blob/master/routes/rna-rsem.md): RNA-seq using RSEM. Generates FPKM/TPM/counts matrix and various QC metrics.
* [rna-snv](https://github.com/igordot/sns/blob/master/routes/rna-snv.md): RNA-seq variant detection. Generates BAMs, VCFs, and various QC metrics.
* [wgbs](https://github.com/igordot/sns/blob/master/routes/rrbs.md): WGBS methylation analysis.
* [rrbs](https://github.com/igordot/sns/blob/master/routes/rrbs.md): RRBS methylation analysis.
* [wes](https://github.com/igordot/sns/blob/master/routes/wes.md): Whole genome/exome/targeted variant detection. Generates BAMs, VCFs, and various QC metrics.
* [atac](https://github.com/igordot/sns/blob/master/routes/atac.md): ATAC-seq. Generates BAMs, bigWigs, peaks, nucleosome positions, and various QC metrics.
* [species](https://github.com/igordot/sns/blob/master/routes/species.md): Species/metagenomics/contamination analysis.

There are additional routes for comparing groups of samples after individual samples are processed with a generic route.
They depend on the output of the generic routes and must be run from the same directory.
Before running, manually add proper group names or pairs to the `samples.groups.csv` or `samples.pairs.csv` files (depending on the comparison type).
Available comparison routes:

* `rna-star-groups-dge`: Differential gene expression using DESeq2 for the `rna-star` results.
* `wes-pairs-snv`: Somatic variant detection for the `wes` results.
* [rna-star-groups-dge](https://github.com/igordot/sns/blob/master/routes/rna-star-groups-dge.md): Differential gene expression using DESeq2 for the `rna-star` results.
* [wes-pairs-snv](https://github.com/igordot/sns/blob/master/routes/wes-pairs-snv.md): Somatic variant detection for the `wes` results.

## Output

* Directories for different output types (such as BAMs or bigWigs) containing files for each sample.
* `summary-combined.*.csv`: Combined segment summaries table that provides a comprehensive overview of the project.
* `logs-*` directories: Most stdout/stderr output will be placed here. The information can be used for tracking progress and troubleshooting.

Each route has a description with more specific details.

## About

SNS is designed to work on NYULMC HPC cluster using the Sun Grid Engine job scheduler.
Expand Down

0 comments on commit 763c6e5

Please sign in to comment.