Commit b5e2828c authored by Brandi Cantarel's avatar Brandi Cantarel
Browse files

update README and config

parent b58a2175
## RNASeq Analysis Worklow
# RNASeq Analysis Worklow
This workflow can be run in with the whole genome, or with a specific list of genes of interest.
## Initiate Nextflow Workflows
### Required Tools
This pipeline uses [Nextflow](https://www.nextflow.io/docs/latest/index.html), a bioinformatics workflow tool and [Singularity](https://sylabs.io/docs/), a containerization tool.
Make sure both tools rae installed before running this pipeline. If running on a HPC cluster then load required modules.
```
module load nextflow/20.01.0 singularity/3.5.3
```
### RNA Design File
The design file must named design.txt and be in tab seperated format for the workflows. All RNA workflows can be run usin the same design file format. You can run in single-end mode with blank cells in the FqR2 column.
| SampleID | CaseID | FqR1 | FqR2 |
|---|---|---|---|
| Sample1 | Fam1 | Sample1.R1.fastq.gz | Sample1.R2.fastq.gz |
| Sample2 | Fam1 | Sample2.R1.fastq.gz | Sample2.R2.fastq.gz |
| Sample3 | Fam2 | Sample3.R1.fastq.gz | Sample3.R2.fastq.gz |
| Sample4 | Fam2 | Sample4.R1.fastq.gz | Sample4.R2.fastq.gz |
### RNA Parameters
* **--input**
* directory containing the design file and fastq files
* default is set to *'${basedir}/fastq'*
* eg: **--input '/project/shared/bicf_workflow_ref/workflow_testdata/rnaseq/fastq'**
* **--output**
* directory for the analysis output
* default is set to *'${basedir}/analysis'*
* eg: **--output '${basedir}/output'**
* **--genome**
* directory containing all reference files for the various tools. This includes the genome.fa, gencode.gtf, genenames.txt, ect.
* default is set for use on UTSW BioHPC.
* eg: **--genome '/project/shared/bicf_workflow_ref/human/grch38_cloud/rnaref'**
* **--stranded**
* option for -s flag in featurecount used in geneabundance calculations
* default is set to *'0'*
* eg: **--stranded '0'**
* **--pairs**
* select either 'pe' (paired-end) or 'se' (single-end) based on read inputs. Select 'pe' when both R1 and R2 are present. If only R1, then select 'se'.
* default is set to *'pe'*
* eg: **--pairs 'pe'**
* **--align**
* select the algorithm/tool for alignment from 'hisat' or 'star'
* default is set to *'hisat'*
* eg: **--align 'hisat'**
* **--markdups**
* select either picard (Mark Duplicates) or null (do not Mark Duplicates)
* default is set to *'picard'*
* eg: **--align 'picard'**
### RNA Run Workflow Testing
Human PE
```
module load nextflow/20.01.0 singularity/3.5.3
base=$repoClonedDirectory
datadir='/project/shared/bicf_workflow_ref/workflow_testdata/rnaseq'
nextflow -C ${base}/nextflow.config run ${base}/workflow/main.nf --design ${datadir}/design.rnaseq.txt --input ${datadir} --output analysis
```
module load nextflow
nextflow run workflow/main.nf
Mouse SE
```
module load nextflow/20.01.0 singularity/3.5.3
base=$repoClonedDirectory
datadir='/project/shared/bicf_workflow_ref/workflow_testdata/rnaseq'
nextflow -C ${base}/nextflow.config run -with-dag flowchart.png -with-timeline mouse_timeline.html -with-report mouse_report.html ${base}/workflow/main.nf --design ${datadir}/mouse_se.design.txt --input ${datadir} --pairs se --output analysis
```
......@@ -32,6 +32,9 @@ process {
withLabel: geneabund {
container = 'goalconsortium/rna_gene_abundance:1.1.3'
}
withLabel: rnaseqstat {
container = 'goalconsortium/rna_statanal:1.1.4'
}
}
singularity {
......@@ -64,7 +67,7 @@ env {
manifest {
homePage = 'https://git.biohpc.swmed.edu/BICF/Astrocyte/rnaseq'
description = 'RNA sequencing gene abundance analysi'
description = 'RNA sequencing gene abundance analysis'
mainScript = 'rna.nf'
version = '1.0.0'
nextflowVersion = '>=20.01.0'
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment