nf_core.utils¶
Common utility functions for the nf-core python package.
- class nf_core.utils.Pipeline(wf_path)¶
Bases:
objectObject to hold information about a local pipeline.
- Parameters
path (str) – The path to the nf-core pipeline directory.
- conda_config¶
The parsed conda configuration file content (
environment.yml).- Type
dict
- conda_package_info¶
The conda package(s) information, based on the API requests to Anaconda cloud.
- Type
dict
- nf_config¶
The Nextflow pipeline configuration file content.
- Type
dict
- files¶
A list of files found during the linting process.
- Type
list
- git_sha¶
The git sha for the repo commit / current GitHub pull-request ($GITHUB_PR_COMMIT)
- Type
str
- minNextflowVersion¶
The minimum required Nextflow version to run the pipeline.
- Type
str
- wf_path¶
Path to the pipeline directory.
- Type
str
- pipeline_name¶
The pipeline name, without the nf-core tag, for example hlatyping.
- Type
str
- schema_obj¶
A
PipelineSchemaobject- Type
obj
- _fp(fn)¶
Convenience function to get full path to a file in the pipeline
- _list_files()¶
Get a list of all files in the pipeline
- _load()¶
Run core load functions
- _load_conda_environment()¶
Try to load the pipeline environment.yml file, if it exists
- _load_pipeline_config()¶
Get the nextflow config for this pipeline
Once loaded, set a few convienence reference class attributes
- nf_core.utils.anaconda_package(dep, dep_channels=['conda-forge', 'bioconda', 'defaults'])¶
Query conda package information.
Sends a HTTP GET request to the Anaconda remote API.
- Parameters
dep (str) – A conda package name.
dep_channels (list) – list of conda channels to use
- Raises
A LookupError, if the connection fails or times out or gives an unexpected status code –
A ValueError, if the package name can not be found (404) –
- nf_core.utils.check_if_outdated(current_version=None, remote_version=None, source_url='https://nf-co.re/tools_version')¶
Check if the current version of nf-core is outdated
- nf_core.utils.custom_yaml_dumper()¶
Overwrite default PyYAML output to make Prettier YAML linting happy
- nf_core.utils.fetch_wf_config(wf_path)¶
Uses Nextflow to retrieve the the configuration variables from a Nextflow workflow.
- Parameters
wf_path (str) – Nextflow workflow file system path.
- Returns
Workflow configuration settings.
- Return type
dict
- nf_core.utils.get_biocontainer_tag(package, version)¶
Given a bioconda package and version, looks for Docker and Singularity containers using the biocontaineres API, e.g.: https://api.biocontainers.pro/ga4gh/trs/v2/tools/{tool}/versions/{tool}-{version} Returns the most recent container versions by default. :param package: A bioconda package name. :type package: str :param version: Version of the bioconda package :type version: str
- Raises
A LookupError, if the connection fails or times out or gives an unexpected status code –
A ValueError, if the package name can not be found (404) –
- nf_core.utils.get_repo_releases_branches(pipeline, wfs)¶
Fetches details of a nf-core workflow to download.
- Parameters
pipeline (str) – GitHub repo username/repo
wfs – A nf_core.list.Workflows() object, where get_remote_workflows() has been called.
- Returns
Array of releases, Array of branches
- Return type
wf_releases, wf_branches (tuple)
- Raises
LockupError, if the pipeline can not be found. –
- nf_core.utils.github_api_auto_auth()¶
- nf_core.utils.is_file_binary(path)¶
Check file path to see if it is a binary file
- nf_core.utils.is_pipeline_directory(wf_path)¶
Checks if the specified directory have the minimum required files (‘main.nf’, ‘nextflow.config’) for a pipeline directory
- Parameters
wf_path (str) – The directory to be inspected
- Raises
UserWarning – If one of the files are missing
- nf_core.utils.load_tools_config(dir='.')¶
Parse the nf-core.yml configuration file
Look for a file called either .nf-core.yml or .nf-core.yaml
Also looks for the deprecated file .nf-core-lint.yml/yaml and issues a warning that this file will be deprecated in the future
Returns the loaded config dict or False, if the file couldn’t be loaded
- nf_core.utils.nextflow_cmd(cmd)¶
Run a Nextflow command and capture the output. Handle errors nicely
- nf_core.utils.parse_anaconda_licence(anaconda_response, version=None)¶
Given a response from the anaconda API using anaconda_package, parse the software licences.
Returns: Set of licence types
- nf_core.utils.pip_package(dep)¶
Query PyPI package information.
Sends a HTTP GET request to the PyPI remote API.
- Parameters
dep (str) – A PyPI package name.
- Raises
A LookupError, if the connection fails or times out –
A ValueError, if the package name can not be found –
- nf_core.utils.poll_nfcore_web_api(api_url, post_data=None)¶
Poll the nf-core website API
Takes argument api_url for URL
Expects API reponse to be valid JSON and contain a top-level ‘status’ key.
- nf_core.utils.prompt_pipeline_release_branch(wf_releases, wf_branches)¶
Prompt for pipeline release / branch
- Parameters
wf_releases (array) – Array of repo releases as returned by the GitHub API
wf_branches (array) – Array of repo branches, as returned by the GitHub API
- Returns
Selected release / branch name
- Return type
choice (str)
- nf_core.utils.prompt_remote_pipeline_name(wfs)¶
Prompt for the pipeline name with questionary
- Parameters
wfs – A nf_core.list.Workflows() object, where get_remote_workflows() has been called.
- Returns
GitHub repo - username/repo
- Return type
pipeline (str)
- Raises
AssertionError, if pipeline cannot be found –
- nf_core.utils.rich_force_colors()¶
Check if any environment variables are set to force Rich to use coloured output
- nf_core.utils.setup_requests_cachedir()¶
Sets up local caching for faster remote HTTP requests.
Caching directory will be set up in the user’s home directory under a .nfcore_cache subdir.
- nf_core.utils.wait_cli_function(poll_func, poll_every=20)¶
Display a command-line spinner while calling a function repeatedly.
Keep waiting until that function returns True
- Parameters
poll_func (function) – Function to call
poll_every (int) – How many tenths of a second to wait between function calls. Default: 20.
- Returns
None. Just sits in an infite loop until the function returns True.