Merge pull request nf-core#557 from MaxUlysse/CleanUp

Cleaning up
UCL-BLIC · Apr 3, 2018 · 06d0712 · 06d0712
2 parents 04d2286 + 105ebd0
commit 06d0712
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 126 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,25 +1,25 @@
-# CAW Contributing Guidelines
+# Sarek Contributing Guidelines
 
-Hi there! Many thanks for taking an interest in improving CAW.
+Hi there! Many thanks for taking an interest in improving Sarek.
 
-We try to manage the required tasks for CAW using GitHub issues, you probably came to this page when creating one. Please use the prefilled template to save time.
+We try to manage the required tasks for Sarek using GitHub issues, you probably came to this page when creating one. Please use the prefilled template to save time.
 
 However, don't be put off by this template - other more general issues and suggestions are welcome! Contributions to the code are even more welcome ;)
 
-> If you need help using CAW then the best place to go is the Gitter chatroom where you can ask us questions directly: https://gitter.im/SciLifeLab/CAW
+> If you need help using Sarek then the best place to go is the Gitter chatroom where you can ask us questions directly: https://gitter.im/SciLifeLab/Sarek
 
 ## Contribution workflow
-If you'd like to write some code for CAW, the standard workflow
+If you'd like to write some code for Sarek, the standard workflow
 is as follows:
 
 1. Check that there isn't already an issue about your idea in the
-   [CAW issues](https://github.com/SciLifeLab/CAW/issues) to avoid
+   [Sarek issues](https://github.com/SciLifeLab/Sarek/issues) to avoid
    duplicating work.
     * Feel free to add a new issue here for the same reason.
-2. Fork the CAW repository to your GitHub account
+2. Fork the Sarek repository to your GitHub account
 3. Make the necessary changes / additions within your forked repository
 4. Submit a Pull Request against the master branch and wait for the code to be reviewed and merged.
 
 If you're not used to this workflow with git, you can start with some [basic docs from GitHub](https://help.github.com/articles/fork-a-repo/) or even their [excellent interactive tutorial](https://try.github.io/).
 
-For further information/help, please consult the [CAW documentation](https://github.com/SciLifeLab/CAW#documentation) and don't hesitate to get in touch on [Gitter](https://gitter.im/SciLifeLab/CAW) or contact us: maxime.garcia@scilifelab.se, szilveszter.juhos@scilifelab.se
+For further information/help, please consult the [Sarek documentation](https://github.com/SciLifeLab/Sarek#documentation) and don't hesitate to get in touch on [Gitter](https://gitter.im/SciLifeLab/Sarek) or contact us: maxime.garcia@scilifelab.se, szilveszter.juhos@scilifelab.se
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,9 +1,9 @@
 <!--
 Hi there!
 
-Many thanks for creating a CAW issue.
+Many thanks for creating a Sarek issue.
 
-Most issues fall into two categories: either you're reporting a problem with CAW or you'd like a change/improvement.
+Most issues fall into two categories: either you're reporting a problem with Sarek or you'd like a change/improvement.
 
 To make sure that you include all of the information needed, please use the template below, you can delete what is not needed.
 
@@ -35,9 +35,9 @@ or ideas how to implement the addition or change
 Providing context helps us coming up with a solution
 Include as many relevant details about the environment you experienced the bug in
 -->
-- **CAW `nextflow.log`:**
+- **Sarek `nextflow.log`:**
   <!-- Re-execute the command line that resulted in a bug with --verbose and -resume and join the .nextflow.log -->
   - [please drag and drop the `.nextflow.log` file that will help understand the error here]
-- **CAW `input.TSV`:**
+- **Sarek `input.TSV`:**
   <!-- Anonymize your TSV file if necessary and join it too  -->
   - [please drag and drop the `TSV` file that will help reproduce or understand the error here]
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,4 @@
 Annotation/
-data/chr17_testdata/
 Preprocessing/
 References/
 Reports/

diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ The worflow steps and tools used are as follows:
     * Variant annotation
         * [SnpEff](http://snpeff.sourceforge.net/)
         * [VEP](https://www.ensembl.org/info/docs/tools/vep/index.html) (Variant Effect Predictor)
-5. **Reporting**
+5. **Reporting** - `runMultiQC.nf`
     * Reporting
         * [MultiQC](http://multiqc.info)
 

diff --git a/annotate.nf b/annotate.nf
@@ -243,15 +243,7 @@ def helpMessage() {
   // Display help message
   this.sarekMessage()
   log.info "    Usage:"
-  log.info "       nextflow run SciLifeLab/Sarek --sample <file.tsv> [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --sampleDir <Directory> [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --test [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
-  log.info "    --step"
-  log.info "       Option to start workflow"
-  log.info "       Possible values are:"
-  log.info "         annotate (will annotate Variant Calling output."
-  log.info "         By default it will try to annotate all available vcfs."
-  log.info "         Use with --annotateTools or --annotateVCF to specify what to annotate"
+  log.info "       nextflow run annotate.nf --test [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
   log.info "    --noReports"
   log.info "       Disable QC tools and MultiQC to generate a HTML report"
   log.info "    --tools"

diff --git a/buildContainers.nf b/buildContainers.nf
@@ -203,12 +203,12 @@ def helpMessage() {
   // Display help message
   this.sarekMessage()
   log.info "    Usage:"
-  log.info "       nextflow run SciLifeLab/Sarek/buildContainers.nf [--docker] [--push]"
+  log.info "       nextflow run buildContainers.nf [--docker] [--push]"
   log.info "          [--containers <container1...>] [--singularity]"
   log.info "          [--containerPath <path>]"
   log.info "          [--tag <tag>] [--repository <repository>]"
   log.info "    Example:"
-  log.info "      nextflow run SciLifeLab/Sarek/buildContainers.nf --docker --containers sarek"
+  log.info "      nextflow run buildContainers.nf --docker --containers sarek"
   log.info "    --containers: Choose which containers to build"
   log.info "       Default: all"
   log.info "       Possible values:"

diff --git a/buildReferences.nf b/buildReferences.nf
@@ -297,14 +297,12 @@ def helpMessage() {
   log.info "    Usage:"
   log.info "       nextflow run buildReferences.nf --refDir <pathToRefDir> --genome <genome>"
   log.info "       nextflow run buildReferences.nf --download --genome smallGRCh37"
-  log.info "       nextflow run SciLifeLab/Sarek --test [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
   log.info "    --download"
   log.info "       Download reference files. (only with --genome smallGRCh37)"
   log.info "    --refDir <Directoy>"
   log.info "       Specify a directory containing reference files."
   log.info "    --outDir <Directoy>"
   log.info "       Specify an output directory"
-  log.info "       Default: \$PWD/References/"
   log.info "    --genome <Genome>"
   log.info "       Choose which genome to build references from"
   log.info "       Possible values are:"

diff --git a/doc/INSTALL.md b/doc/INSTALL.md
@@ -4,7 +4,7 @@ This small tutorial will explain to you how to install and run Sarek on a small
 
 To use this pipeline, you need to have a working version of Nextflow installed, Reference files and Docker or Singularity to facilitate the use of other tools. You can use a small reference genome as testing
 
-- See the [Install Nextflow documentation](https://github.com/SciLifeLab/NGI-NextflowDocs/blob/master/docs/INSTALL.md)
+- See the [Install Nextflow documentation](https://www.nextflow.io/docs/latest/getstarted.html#installation)
 - See the [Reference files documentation](REFERENCES.md)
 - See the [Install Docker documentation](https://docs.docker.com/engine/installation/linux/ubuntu/#install-docker)
 - See the [Install Singularity documentation](http://singularity.lbl.gov/install-linux)

diff --git a/germlineVC.nf b/germlineVC.nf
@@ -662,13 +662,8 @@ def defineDirectoryMap() {
 def defineReferenceMap() {
   if (!(params.genome in params.genomes)) exit 1, "Genome ${params.genome} not found in configuration"
   return [
-    // loci file for ascat
-    'acLoci'           : checkParamReturnFile("acLoci"),
     'dbsnp'            : checkParamReturnFile("dbsnp"),
     'dbsnpIndex'       : checkParamReturnFile("dbsnpIndex"),
-    // cosmic VCF with VCF4.1 header
-    'cosmic'           : checkParamReturnFile("cosmic"),
-    'cosmicIndex'      : checkParamReturnFile("cosmicIndex"),
     // genome reference dictionary
     'genomeDict'       : checkParamReturnFile("genomeDict"),
     // FASTA genome reference
@@ -741,52 +736,20 @@ def helpMessage() {
   // Display help message
   this.sarekMessage()
   log.info "    Usage:"
-  log.info "       nextflow run SciLifeLab/Sarek --sample <file.tsv> [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --sampleDir <Directory> [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --test [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
+  log.info "       nextflow run germlineVC.nf --sample <file.tsv> [--tools TOOL[,TOOL]] --genome <Genome>"
   log.info "    --sample <file.tsv>"
   log.info "       Specify a TSV file containing paths to sample files."
-  log.info "    --sampleDir <Directoy>"
-  log.info "       Specify a directory containing sample files."
   log.info "    --test"
   log.info "       Use a test sample."
-  log.info "    --step"
-  log.info "       Option to start workflow"
-  log.info "       Possible values are:"
-  log.info "         mapping (default, will start workflow with FASTQ files)"
-  log.info "         realign (will start workflow with non-realigned BAM files)"
-  log.info "         recalibrate (will start workflow with non-recalibrated BAM files)"
-  log.info "         variantcalling (will start workflow with recalibrated BAM files)"
-  log.info "         annotate (will annotate Variant Calling output."
-  log.info "         By default it will try to annotate all available vcfs."
-  log.info "         Use with --annotateTools or --annotateVCF to specify what to annotate"
   log.info "    --noReports"
   log.info "       Disable QC tools and MultiQC to generate a HTML report"
   log.info "    --tools"
   log.info "       Option to configure which tools to use in the workflow."
   log.info "         Different tools to be separated by commas."
   log.info "       Possible values are:"
-  log.info "         mutect1 (use MuTect1 for VC)"
-  log.info "         mutect2 (use MuTect2 for VC)"
-  log.info "         freebayes (use FreeBayes for VC)"
   log.info "         strelka (use Strelka for VC)"
   log.info "         haplotypecaller (use HaplotypeCaller for normal bams VC)"
   log.info "         manta (use Manta for SV)"
-  log.info "         ascat (use Ascat for CNV)"
-  log.info "         snpeff (use snpEff for Annotation of Variants)"
-  log.info "         vep (use VEP for Annotation of Variants)"
-  log.info "    --annotateTools"
-  log.info "       Option to configure which tools to annotate."
-  log.info "         Different tools to be separated by commas."
-  log.info "       Possible values are:"
-  log.info "         haplotypecaller (Annotate HaplotypeCaller output)"
-  log.info "         manta (Annotate Manta output)"
-  log.info "         mutect1 (Annotate MuTect1 output)"
-  log.info "         mutect2 (Annotate MuTect2 output)"
-  log.info "         strelka (Annotate Strelka output)"
-  log.info "    --annotateVCF"
-  log.info "       Option to configure which vcf to annotate."
-  log.info "         Different vcf to be separated by commas."
   log.info "    --genome <Genome>"
   log.info "       Use a specific genome version."
   log.info "       Possible values are:"
@@ -818,9 +781,6 @@ def minimalInformationMessage() {
   else log.info "  ContainerPath: " + params.containerPath
   log.info "  Tag          : " + params.tag
   log.info "Reference files used:"
-  log.info "  acLoci      :\n\t" + referenceMap.acLoci
-  log.info "  cosmic      :\n\t" + referenceMap.cosmic
-  log.info "\t" + referenceMap.cosmicIndex
   log.info "  dbsnp       :\n\t" + referenceMap.dbsnp
   log.info "\t" + referenceMap.dbsnpIndex
   log.info "  genome      :\n\t" + referenceMap.genomeFile

diff --git a/main.nf b/main.nf
@@ -844,7 +844,6 @@ def helpMessage() {
   log.info "    Usage:"
   log.info "       nextflow run SciLifeLab/Sarek --sample <file.tsv> [--step STEP] --genome <Genome>"
   log.info "       nextflow run SciLifeLab/Sarek --sampleDir <Directory> [--step STEP] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --test [--step STEP] --genome <Genome>"
   log.info "    --sample <file.tsv>"
   log.info "       Specify a TSV file containing paths to sample files."
   log.info "    --sampleDir <Directoy>"

diff --git a/runMultiQC.nf b/runMultiQC.nf
@@ -164,37 +164,11 @@ def helpMessage() {
   // Display help message
   this.sarekMessage()
   log.info "    Usage:"
-  log.info "       nextflow run SciLifeLab/Sarek --sample <file.tsv> [--step STEP] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --sampleDir <Directory> [--step STEP] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --test [--step STEP] --genome <Genome>"
-  log.info "    --sample <file.tsv>"
-  log.info "       Specify a TSV file containing paths to sample files."
-  log.info "    --sampleDir <Directoy>"
-  log.info "       Specify a directory containing sample files."
-  log.info "    --test"
-  log.info "       Use a test sample."
-  log.info "    --step"
-  log.info "       Option to start workflow"
-  log.info "       Possible values are:"
-  log.info "         mapping (default, will start workflow with FASTQ files)"
-  log.info "         realign (will start workflow with non-realigned BAM files)"
-  log.info "         recalibrate (will start workflow with non-recalibrated BAM files)"
-  log.info "    --noReports"
-  log.info "       Disable QC tools and MultiQC to generate a HTML report"
-  log.info "    --genome <Genome>"
-  log.info "       Use a specific genome version."
-  log.info "       Possible values are:"
-  log.info "         GRCh37"
-  log.info "         GRCh38 (Default)"
-  log.info "         smallGRCh37 (Use a small reference (Tests only))"
-  log.info "    --onlyQC"
-  log.info "       Run only QC tools and gather reports"
+  log.info "       nextflow run runMultiQC.nf"
   log.info "    --help"
   log.info "       you're reading it"
   log.info "    --verbose"
   log.info "       Adds more verbosity to workflow"
-  log.info "    --version"
-  log.info "       displays version number"
 }
 
 def minimalInformationMessage() {

diff --git a/somaticVC.nf b/somaticVC.nf
@@ -981,25 +981,11 @@ def helpMessage() {
   // Display help message
   this.sarekMessage()
   log.info "    Usage:"
-  log.info "       nextflow run SciLifeLab/Sarek --sample <file.tsv> [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --sampleDir <Directory> [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
-  log.info "       nextflow run SciLifeLab/Sarek --test [--step STEP] [--tools TOOL[,TOOL]] --genome <Genome>"
+  log.info "       nextflow run somaticVC.nf --sample <file.tsv> [--tools TOOL[,TOOL]] --genome <Genome>"
   log.info "    --sample <file.tsv>"
   log.info "       Specify a TSV file containing paths to sample files."
-  log.info "    --sampleDir <Directoy>"
-  log.info "       Specify a directory containing sample files."
   log.info "    --test"
   log.info "       Use a test sample."
-  log.info "    --step"
-  log.info "       Option to start workflow"
-  log.info "       Possible values are:"
-  log.info "         mapping (default, will start workflow with FASTQ files)"
-  log.info "         realign (will start workflow with non-realigned BAM files)"
-  log.info "         recalibrate (will start workflow with non-recalibrated BAM files)"
-  log.info "         variantcalling (will start workflow with recalibrated BAM files)"
-  log.info "         annotate (will annotate Variant Calling output."
-  log.info "         By default it will try to annotate all available vcfs."
-  log.info "         Use with --annotateTools or --annotateVCF to specify what to annotate"
   log.info "    --noReports"
   log.info "       Disable QC tools and MultiQC to generate a HTML report"
   log.info "    --tools"
@@ -1013,20 +999,6 @@ def helpMessage() {
   log.info "         haplotypecaller (use HaplotypeCaller for normal bams VC)"
   log.info "         manta (use Manta for SV)"
   log.info "         ascat (use Ascat for CNV)"
-  log.info "         snpeff (use snpEff for Annotation of Variants)"
-  log.info "         vep (use VEP for Annotation of Variants)"
-  log.info "    --annotateTools"
-  log.info "       Option to configure which tools to annotate."
-  log.info "         Different tools to be separated by commas."
-  log.info "       Possible values are:"
-  log.info "         haplotypecaller (Annotate HaplotypeCaller output)"
-  log.info "         manta (Annotate Manta output)"
-  log.info "         mutect1 (Annotate MuTect1 output)"
-  log.info "         mutect2 (Annotate MuTect2 output)"
-  log.info "         strelka (Annotate Strelka output)"
-  log.info "    --annotateVCF"
-  log.info "       Option to configure which vcf to annotate."
-  log.info "         Different vcf to be separated by commas."
   log.info "    --genome <Genome>"
   log.info "       Use a specific genome version."
   log.info "       Possible values are:"