diff --git a/CHANGES.md b/CHANGES.md index 6f7fb1641c5c2b32c51055a44da05fe815c44bed..72a26029a8c01bd36bca6cdc9a33ee5beef57a05 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,7 @@ +2024-10-10 + +Enabled containerization with nf-core cellranger image. + 2024-06-20 Added support for barnyard reference. diff --git a/README.md b/README.md index cfa34aee97bb5885e7ac0236ea40726c1e4184d7..b7a9e1dea58bbef757ed48084b2651a8e6c98e1c 100755 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ Output are standard cellranger outputs, including a cell-by-gene matrix in both MTX and h5 formats, a summary of the run in an HTML output, and a BAM file of aligned reads. These outputs can then be used for downstream analysis. +Note: this workflow runs cellranger-count in a container, and is neither +provided nor supported by 10x Genomics. + ## Parameters - Fastq: The fastq files for the sample. Regardless of the files that are diff --git a/astrocyte_pkg.yml b/astrocyte_pkg.yml index 4416824eae7af7f878206fd464e3106360beb1f4..04abe5be5389e3e59f83f15f7438d34dcffc1fda 100755 --- a/astrocyte_pkg.yml +++ b/astrocyte_pkg.yml @@ -66,9 +66,17 @@ documentation_files: # A list of cluster environment modules that this workflow requires to run. # Specify versioned module names to ensure reproducibility. workflow_modules: - - 'cellranger/7.1.0' - 'singularity/3.9.9' + # A list of container images requires to run this workflow. +# Specify full path and version names to ensure reproducibility. +# This keyword is required when 'container' is specified in Astrocyte 0.4.1 and above. +# Singularity supports different registries, please specify the protocol to use. +# Such as, "docker://", "shub://", "library://", etc. We encourage you to use the GitLab +# container registry of BioHPC to save and manage your container images. +workflow_containers: + - docker://quay.io/nf-core/cellranger:7.1.0 + # A list of parameters used by the workflow, defining how to present them, # options etc in the web interface. For each parameter: # diff --git a/docs/index.md b/docs/index.md index 86081a485da59bf2136216004c740724adf2568a..fa3d5b52d1406ef64e903e2513a2fd5e7ea22baf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,6 +5,10 @@ Chromium single cell gene expression workflows. It accepts fastq.gz files as input, which can be generated with the "BICF CellRanger mkfastq" Astrocyte workflow. +Note: this workflow runs cellranger-count in a container, and is neither +provided nor supported by 10x Genomics. + + ## Parameters To run this workflow, you must supply the following parameters: diff --git a/workflow/configs/biohpc.config b/workflow/configs/biohpc.config index a668f1d487c0762bb77e095ef1c0ee3c8711f686..9c8497913b80758576a43c1697b9b4d00bffc8a9 100755 --- a/workflow/configs/biohpc.config +++ b/workflow/configs/biohpc.config @@ -3,8 +3,16 @@ process { clusterOptions = '--no-kill' queue = '512GB,256GB,256GBv1,128GB' time = '8h' + container = 'docker://quay.io/nf-core/cellranger:7.1.0' } +singularity { + enabled = true + runOptions = '--nv' + cacheDir = "${projectDir}/images/singularity" +} + + // Overwrite execution report files // Required for nextflow version >22.10.0 diff --git a/workflow/main.nf b/workflow/main.nf index edf3b021ba2f1ec8f4bb014346f5cb7867787e10..9271c5869200072dfdc33197926b67cd5d86e8ce 100755 --- a/workflow/main.nf +++ b/workflow/main.nf @@ -20,7 +20,6 @@ params.astrocyte = false // Run cellranger count process cr_count { publishDir "${params.outDir}", mode: 'copy' - module 'cellranger/7.1.0' module 'singularity/3.9.9' errorStrategy 'ignore'