• API Reference
  • Tests:
  • Home
  • Pipelines
  • Resources
    • Components
    • Modules
    • Subworkflows

    • Configs
    • Shared configs
  • Docs
  • Community
    • What's happening
    • Blog

    • Events
    • Bytesize Talks
    • Hackathons
    • Training
    • Talks

    • Programs and groups
    • Special interest groups
    • Mentorships
    • Contributors
    • Shop new
    • Connect game 👾
  • About
    • About nf-core
    • Stickers
    • Governance
    • Marketing
    • Code of conduct

    • Publications
    • Statistics

    • Join nf-core
    • Select theme
    • Light
    • Dark
    • System
    • Select theme
    • Light
    • Dark
    • System
    Join nf-core Join nf-core

nf-core/tools API documentation
Edit

Automated documentation for nf-core/tools (2.9)

API Reference

Tests:

  • nf_core.bump_version
    • bump_nextflow_version()
    • bump_pipeline_version()
    • update_file_version()
  • nf_core.create
    • PipelineCreate
  • nf_core.download
    • ContainerError
    • DownloadError
    • DownloadProgress
    • DownloadWorkflow
    • WorkflowRepo
  • nf_core.launch
    • Launch
  • nf_core.licences
    • WorkflowLicences
  • nf_core.lint
    • run_linting()
    • PipelineLint
  • nf_core.list
    • LocalWorkflow
    • RemoteWorkflow
    • Workflows
    • get_local_wf()
    • list_workflows()
    • pretty_date()
  • nf_core.modules
  • nf_core.schema
    • PipelineSchema
  • nf_core.subworkflows
  • nf_core.sync
    • PipelineSync
    • PullRequestException
    • SyncException
  • nf_core.utils
    • GitHub_API_Session
    • Pipeline
    • SingularityCacheFilePathValidator
    • anaconda_package()
    • check_if_outdated()
    • custom_yaml_dumper()
    • determine_base_dir()
    • fetch_remote_version()
    • fetch_wf_config()
    • file_md5()
    • get_biocontainer_tag()
    • get_first_available_path()
    • get_repo_releases_branches()
    • is_file_binary()
    • is_pipeline_directory()
    • is_relative_to()
    • load_tools_config()
    • nextflow_cmd()
    • parse_anaconda_licence()
    • pip_package()
    • plural_es()
    • plural_s()
    • plural_y()
    • poll_nfcore_web_api()
    • prompt_pipeline_release_branch()
    • prompt_remote_pipeline_name()
    • rich_force_colors()
    • setup_nfcore_dir()
    • setup_requests_cachedir()
    • sort_dictionary()
    • strip_ansi_codes()
    • validate_file_md5()
    • wait_cli_function()
  • dev
  • 3.2.1
  • 3.2.0
  • 3.1.2
  • 3.1.1
  • 3.1.0
  • 3.0.2
  • 3.0.1
  • 3.0.0
  • 2.14.1
  • 2.14.0
  • 2.13.1
  • 2.13
  • 2.12
  • 2.12.1
  • 2.11
  • 2.11.1
  • 2.10
  • 2.9
  • 2.8
  • 2.7
  • 2.7.2
  • 2.7.1
  • 2.6
  • 2.5
  • 2.5.1
  • 2.4
  • 2.4.1
  • 2.3
  • 2.3.2
  • 2.3.1
  • 2.2
  • 2.1
  • 2.0
  • 2.0.1
  • 1.14
  • 1.13
  • 1.13.3
  • 1.13.2
  • 1.13.1
  • 1.12
  • 1.12.1
  • 1.11
  • 1.10
  • 1.10.2
  • 1.10.1
  • 1.9
  • 1.8
  • 1.7
  • 1.6
  • 1.5
  • Pipeline lint tests
    • actions_awsfulltest
    • actions_awstest
    • actions_ci
    • actions_schema_validation
    • files_unchanged
    • merge_markers
    • files_exist
    • modules_json
    • multiqc_config
    • nextflow_config
    • modules_structure
    • pipeline_name_conventions
    • pipeline_todos
    • readme
    • schema_description
    • schema_lint
    • schema_params
    • system_exit
    • template_strings
    • version_consistency
  • Module lint tests
    • main_nf
    • meta_yml
    • module_changes
    • module_deprecations
    • module_patch
    • module_tests
    • module_todos
    • module_version
  • API
    • create
    • bump_version
    • download
    • licences
    • launch
    • lint
    • list
    • modules
    • subworkflows
    • schema
    • utils
    • sync
Making awesome workflows since 2018.

Supported by:

+ + +
See the source code for this website on GitHub:
https://github.com/nf-core/website