diff --git a/docs/index.md b/docs/index.md index 9cf72e4..8a90ec4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,6 +18,7 @@ Make sure the version is 0.1.3 with this command `packageVersion("bcbioR")` or r * Activate your r session to make your working directory to be your project folder: `usethis::proj_activate("/path/to/analysis/folder")` * Start a git repository: `usethis::use_git()` * Only once every 30 days, set up your github credentials: `usethis::gh_token_help()` + * You may want to run this first to keep this token working in future sessions: `git config --global credential.helper store` * Push repository to HBC github as private: `usethis::use_github(org="hbc",private=TRUE)` ## RNAseq @@ -32,7 +33,7 @@ Make sure the version is 0.1.3 with this command `packageVersion("bcbioR")` or r * Follow this instruction https://bcbio.github.io/bcbioR/#set-base-project to start you project * Follow this instruction https://bcbio.github.io/bcbioR/#set-rnaseq-report-folder to start your RNAseq analysis -# BCBIOR Supported Templates +# bcbioR Supported Templates We used `bcbioR` to deploy folders and code to our project directories to improve robustness in our analysis. diff --git a/docs/pipelines.md b/docs/pipelines.md index 75dad19..c0f258c 100644 --- a/docs/pipelines.md +++ b/docs/pipelines.md @@ -49,7 +49,7 @@ module load java/jdk-21.0.2 export NXF_APPTAINER_CACHEDIR=/n/app/singularity/containers/shared/bcbio/ export NXF_SINGULARITY_LIBRARYDIR=/n/app/singularity/containers/shared/bcbio/ -./nextflow run nf-core/rnaseq -profile singularity,test --outdir here +./nextflow run nf-core/rnaseq -r 3.14.0 -profile singularity,test --outdir here -resume ``` ## Nextflow in FAS @@ -69,8 +69,14 @@ Example command to run in an interactive job: /n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow run nf-core/rnaseq -profile test,singularity --outdir tmp -c /n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/fas.config ``` -For non-test data, this is the head job you need to submit: +For non-test data, this is the head job you need to submit. Copy first the config files and modified as needed: +``` +cp /n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/fas.config . +cp /n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/rnaseq.config . +``` + +And then modify this template as needed before using it: ``` #!/bin/bash @@ -92,7 +98,10 @@ export NXF_SINGULARITY_LIBRARYDIR=/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_reso OUTPUT=path_to_results -/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow run nf-core/rnaseq -profile singularity \\ - -c analysis.config \\ - --outdir $OUTPUT -c /n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow/fas.config +/n/holylfs05/LABS/hsph_bioinfo/Lab/shared_resources/nextflow run nf-core/rnaseq -r 3.14.0 \ + -profile singularity \ + -c analysis.config \ + -c rnaseq.config \ + --outdir $OUTPUT -c fas.config \ + -resume ```