Skip to content
Snippets Groups Projects
Commit 126fe448 authored by Gervaise Henry's avatar Gervaise Henry :cowboy:
Browse files

Update README.md

parent 170b0706
Branches
Tags
2 merge requests!37v0.0.1,!28Resolve "Move inference to start of pipeline"
Pipeline #6652 passed with stages
in 59 minutes and 31 seconds
...@@ -9,7 +9,7 @@ RNA-Seq Analytic Pipeline for GUDMAP/RBK ...@@ -9,7 +9,7 @@ RNA-Seq Analytic Pipeline for GUDMAP/RBK
Introduction Introduction
------------ ------------
This pipeline was created to be a standard mRNA-sequencing analysis pipeline which integrates with the GUDMAP and RBK consortium data-hub. This pipeline was created to be a standard mRNA-sequencing analysis pipeline which integrates with the GUDMAP and RBK consortium data-hub. It is designed to run on the HPC cluster ([BioHPC](https://portal.biohpc.swmed.edu)) at UT Southwestern Medical Center (in conjunction with the standard nextflow profile: config `biohpc.config`)
![flowchart](docs/RNA-Seq%20Pipeline%20Design%20Flowchart.jpg "Flowchart") ![flowchart](docs/RNA-Seq%20Pipeline%20Design%20Flowchart.jpg "Flowchart")
...@@ -21,18 +21,19 @@ This pipeline is also capable of being run on AWS. To do so: ...@@ -21,18 +21,19 @@ This pipeline is also capable of being run on AWS. To do so:
* Replace workDir with the S3 bucket generated * Replace workDir with the S3 bucket generated
* Change region if different * Change region if different
* Change queue to the aws batch queue generated * Change queue to the aws batch queue generated
* The user must have awscli configured with an appropriate authentication (with ```aws configure``` and access keys) in the environment which nextflow will be run * The user must have awscli configured with an appropriate authentication (with `aws configure` and access keys) in the environment which nextflow will be run
* Add ```-profile ``` with the name aws config which was customized * Add `-profile` with the name aws config which was customized
To Run: To Run:
------- -------
* Available parameters: * Available parameters:
* ```--deriva``` active **credential.json** file from [deriva-auth](https://github.com/informatics-isi-edu/gudmap-rbk/wiki/Uploading-files-via-Deriva-client-tools#from-a-remote-server) * `--deriva` active **credential.json** file from [deriva-auth](https://github.com/informatics-isi-edu/gudmap-rbk/wiki/Uploading-files-via-Deriva-client-tools#from-a-remote-server)
* ```--bdbag``` active **cookies.txt** file from [deriva-auth](https://github.com/informatics-isi-edu/gudmap-rbk/wiki/Uploading-files-via-Deriva-client-tools#from-a-remote-server) * `--bdbag` active **cookies.txt** file from [deriva-auth](https://github.com/informatics-isi-edu/gudmap-rbk/wiki/Uploading-files-via-Deriva-client-tools#from-a-remote-server)
* ```--repRID``` mRNA-seq replicate RID * `--repRID` mRNA-seq replicate RID
* ```--refMoVersion``` mouse reference version ***(optional)*** * `--refMoVersion` mouse reference version ***(optional)***
* ```--refHuVersion``` human reference version ***(optional)*** * `--refHuVersion` human reference version ***(optional)***
* ```-profile``` config profile to use: standard = local processes on BioHPC (default), biohpc = BioHPC cluster, aws_ondemand = AWS Batch on-demand instant requests, aws_spot = AWS Batch spot instance requests ***(optional)*** * `--refERCCVersion` human reference version ***(optional)***
* `-profile` config profile to use: standard = processes on BioHPC cluster, aws_ondemand = AWS Batch on-demand instant requests, aws_spot = AWS Batch spot instance requests ***(optional)***
* NOTES: * NOTES:
* once deriva-auth is run and authenticated, the two files above are saved in ```~/.deriva/``` (see official documents from [deriva](https://github.com/informatics-isi-edu/deriva-client#installer-packages-for-windows-and-macosx) on the lifetime of the credentials) * once deriva-auth is run and authenticated, the two files above are saved in ```~/.deriva/``` (see official documents from [deriva](https://github.com/informatics-isi-edu/deriva-client#installer-packages-for-windows-and-macosx) on the lifetime of the credentials)
* reference version consists of Genome Reference Consortium version, patch release and GENCODE annotation release # (leaving the params blank will use the default version tied to the pipeline version) * reference version consists of Genome Reference Consortium version, patch release and GENCODE annotation release # (leaving the params blank will use the default version tied to the pipeline version)
...@@ -96,4 +97,4 @@ Please cite in publications: Pipeline was developed by BICF from funding provide ...@@ -96,4 +97,4 @@ Please cite in publications: Pipeline was developed by BICF from funding provide
Pipeline Directed Acyclic Graph Pipeline Directed Acyclic Graph
------------------------------- -------------------------------
![dag](docs/dag.png "DAG") ![dag](docs/dag.png "DAG")
\ No newline at end of file
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