Skip to content

Commit

Permalink
Pulled from template 3.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
nschcolnicov committed Oct 9, 2024
1 parent 60a7f71 commit f60a119
Show file tree
Hide file tree
Showing 12 changed files with 191 additions and 182 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json

### Default processes resource requirements

Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/master/nf_core/pipeline-template/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.
Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/main/nf_core/pipeline-template/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.

The process resources can be passed on to the tool dynamically within the process with the `${task.cpus}` and `${task.memory}` variables in the `script:` block.

Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/awsfulltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,18 @@ on:
jobs:
run-platform:
name: Run AWS full tests
if: github.repository == 'nf-core/smrnaseq' && github.event.review.state == 'approved'
# run only if the PR is approved by at least 2 reviewers and against the master branch or manually triggered
if: github.repository == 'nf-core/smrnaseq' && github.event.review.state == 'approved' && github.event.pull_request.base.ref == 'master' || github.event_name == 'workflow_dispatch'
runs-on: ubuntu-latest
steps:
- uses: octokit/[email protected]
id: check_approvals
with:
route: GET /repos/${{ github.repository }}/pulls/${{ github.event.review.number }}/reviews
route: GET /repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- id: test_variables
if: github.event_name != 'workflow_dispatch'
run: |
JSON_RESPONSE='${{ steps.check_approvals.outputs.data }}'
CURRENT_APPROVALS_COUNT=$(echo $JSON_RESPONSE | jq -c '[.[] | select(.state | contains("APPROVED")) ] | length')
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
- master
release:
types: [published]
workflow_dispatch:

env:
NXF_ANSI_LOG: false
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ jobs:
architecture: "x64"

- name: read .nf-core.yml
uses: pietrobolcato/action-read-yaml@1.0.0
uses: pietrobolcato/action-read-yaml@1.1.0
id: read_yml
with:
config: ${{ github.workspace }}/.nf-core.yaml
config: ${{ github.workspace }}/.nf-core.yml

- name: Install dependencies
run: |
Expand Down
2 changes: 1 addition & 1 deletion .nf-core.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ lint:
nextflow_config:
- config_defaults:
- params.fastp_known_mirna_adapters
nf_core_version: 3.0.0
nf_core_version: 3.0.1
org_path: null
repository_type: pipeline
template:
Expand Down
2 changes: 1 addition & 1 deletion CITATIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

> Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.
- [Bioconductor](https://www.bioconductor.org/) and [R](https://cran.r-project.org/)
- # [Bioconductor](https://www.bioconductor.org/) and [R](https://cran.r-project.org/)

## Software packaging/containerisation tools

Expand Down
4 changes: 2 additions & 2 deletions modules.json
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,12 @@
},
"utils_nextflow_pipeline": {
"branch": "master",
"git_sha": "d20fb2a9cc3e2835e9d067d1046a63252eb17352",
"git_sha": "9d05360da397692321d377b6102d2fb22507c6ef",
"installed_by": ["subworkflows"]
},
"utils_nfcore_pipeline": {
"branch": "master",
"git_sha": "2fdce49d30c0254f76bc0f13c55c17455c1251ab",
"git_sha": "772684d9d66f37b650c8ba5146ac1ee3ecba2acb",
"installed_by": ["subworkflows"]
},
"utils_nfschema_plugin": {
Expand Down
11 changes: 1 addition & 10 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ params {
custom_config_base = "https://raw.githubusercontent.com/nf-core/configs/${params.custom_config_version}"
config_profile_contact = null
config_profile_url = null

// Schema validation default options
validate_params = true

}

// Load base.config by default for all pipelines
Expand Down Expand Up @@ -268,14 +268,6 @@ set -o pipefail # Returns the status of the last command to exit with a non-zero
set -C # No clobber - prevent output redirection from overwriting files.
"""

// Set default registry for Docker and Podman independent of -profile
// Will not be used unless Docker / Podman are enabled
// Set to your registry if you have a mirror of containers
apptainer.registry = 'quay.io'
docker.registry = 'quay.io'
podman.registry = 'quay.io'
singularity.registry = 'quay.io'

// Disable process selector warnings by default. Use debug profile to enable warnings.
nextflow.enable.configProcessNamesValidation = false

Expand Down Expand Up @@ -346,4 +338,3 @@ validation {

// Load modules.config for DSL2 module specific options
includeConfig 'conf/modules.config'

15 changes: 7 additions & 8 deletions subworkflows/local/utils_nfcore_smrnaseq_pipeline/main.nf
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ include { UTILS_NFCORE_PIPELINE } from '../../nf-core/utils_nfcore_pipeline'
include { UTILS_NEXTFLOW_PIPELINE } from '../../nf-core/utils_nextflow_pipeline'

/*
========================================================================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
SUBWORKFLOW TO INITIALISE PIPELINE
========================================================================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/

workflow PIPELINE_INITIALISATION {
Expand Down Expand Up @@ -52,7 +52,6 @@ workflow PIPELINE_INITIALISATION {
workflow.profile.tokenize(',').intersect(['conda', 'mamba']).size() >= 1
)


//
// Validate parameters and generate parameter summary to stdout
//
Expand All @@ -63,6 +62,7 @@ workflow PIPELINE_INITIALISATION {
)



//
// Check config provided to the pipeline
//
Expand Down Expand Up @@ -105,9 +105,9 @@ workflow PIPELINE_INITIALISATION {
}

/*
========================================================================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
SUBWORKFLOW FOR PIPELINE COMPLETION
========================================================================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/

workflow PIPELINE_COMPLETION {
Expand All @@ -116,7 +116,6 @@ workflow PIPELINE_COMPLETION {
email // string: email address
email_on_fail // string: email address sent on pipeline failure
plaintext_email // boolean: Send plain-text email instead of HTML

outdir // path: Path to output directory where results will be published
monochrome_logs // boolean: Disable ANSI colour codes in log output
hook_url // string: hook URL for notifications
Expand Down Expand Up @@ -153,9 +152,9 @@ workflow PIPELINE_COMPLETION {
}

/*
========================================================================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
FUNCTIONS
========================================================================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
//
// Check and validate pipeline parameters
Expand Down
46 changes: 22 additions & 24 deletions subworkflows/nf-core/utils_nextflow_pipeline/main.nf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit f60a119

Please sign in to comment.