Pipeline_Management_Schema.md

graph LR
    PipelineCreate["PipelineCreate"]
    PipelineVersionBumper["PipelineVersionBumper"]
    PipelineLint["PipelineLint"]
    DownloadWorkflow["DownloadWorkflow"]
    ParamsFileBuilder["ParamsFileBuilder"]
    Launch["Launch"]
    Workflows["Workflows"]
    ROCrate["ROCrate"]
    PipelineSync["PipelineSync"]
    PipelineSchema["PipelineSchema"]
    PipelineLint -- "Utilizes" --> PipelineSchema
    Workflows -- "Utilizes" --> DownloadWorkflow
    ParamsFileBuilder -- "Utilizes" --> PipelineSchema
    Workflows -- "Utilizes" --> ParamsFileBuilder
    Launch -- "Utilizes" --> PipelineSchema
    Workflows -- "Utilizes" --> Launch

Loading

Details

Abstract Components Overview of Nextflow Pipelines

PipelineCreate

Orchestrates the creation of new Nextflow pipelines. This involves interactive prompts for pipeline details, generating the initial directory structure, and populating template files based on user input.

Related Classes/Methods:

• nf_core.pipelines.create.create

PipelineVersionBumper

Manages the process of updating the version of an existing Nextflow pipeline. This includes modifying relevant files (e.g., nextflow.config, pyproject.toml) and ensuring version consistency across the pipeline's metadata.

Related Classes/Methods:

• nf_core.pipelines.bump_version

PipelineLint

Performs comprehensive linting and validation checks on Nextflow pipelines to ensure adherence to nf-core guidelines, best practices, and schema definitions. It aggregates various sub-checks for code quality, configuration, and schema compliance.

Related Classes/Methods:

DownloadWorkflow

Handles the downloading of Nextflow pipelines from remote repositories (e.g., GitHub), including specific versions or branches. It manages the local caching and integrity of downloaded pipelines, ensuring they are ready for use.

Related Classes/Methods:

• nf_core.pipelines.download

ParamsFileBuilder

Generates parameter files (e.g., params.json, params.yaml) for Nextflow pipelines based on their defined schemas. This component simplifies pipeline configuration by providing a structured way to define and validate input parameters.

Related Classes/Methods:

• nf_core.pipelines.params_file

Launch

Manages the launching and execution of Nextflow pipelines. It integrates with the schema component to validate parameters before execution, ensuring that the pipeline receives valid inputs.

Related Classes/Methods:

• nf_core.pipelines.launch

Workflows

Provides functionality to list available Nextflow pipelines, both locally (discovered in the current directory or specified paths) and from remote nf-core repositories. It acts as an entry point for various pipeline-related operations.

Related Classes/Methods:

• nf_core.pipelines.list

ROCrate

Handles the generation and management of Research Object (RO) Crates for Nextflow pipelines. RO-Crates package research data, code, and metadata into a single, FAIR-compliant archive, enhancing reproducibility and sharing.

Related Classes/Methods:

• nf_core.pipelines.rocrate

PipelineSync

Synchronizes local Nextflow pipelines with their upstream nf-core templates. This allows pipeline developers to easily update their custom pipelines with the latest changes and features from the official nf-core templates.

Related Classes/Methods:

• nf_core.pipelines.sync

PipelineSchema

Defines, validates, builds, and documents schemas for Nextflow pipeline parameters. This is a critical component for ensuring that pipelines receive valid inputs, generating user-friendly documentation, and enabling automated parameter file generation.

Related Classes/Methods:

• nf_core.pipelines.schema

FAQ