×

nf-core/metaspace/download @ 0.0.0-6c4ed3a

A module to download dataset results from the METASPACE platform and save them as CSV files, using a containerized Python script. Inputs are provided via a CSV file or a list of datasets, with results saved to a specified output directory.

Latest version: 0.0.0-6c4ed3a
Total downloads: 6
Source: nf-core/modules
Authors: @Dewey-Wang
Maintainers: @Dewey-Wang

Summary

A module to download dataset results from the METASPACE platform and save them as CSV files, using a containerized Python script. Inputs are provided via a CSV file or a list of datasets, with results saved to a specified output directory.

Get started

Add the following snippet to your workflow script to include this module.

include { METASPACE_DOWNLOAD } from 'nf-core/metaspace/download'

License

MIT License

Process
Name METASPACE_DOWNLOAD
Input 1 channel
#1 tuple
dataset_id string

The ID of the dataset to process. The ID is the last part of the dataset URL. For example, in the URL https://metaspace2020.org/dataset/2022-08-05_17h28m56s, the dataset_id is 2022-08-05_17h28m56s.

database string

The database to download the dataset from (default: 'HMDB'). If not provided, all dataset will be included.

version string

The version of the database to download the dataset from (default: 'v4'). If not provided, all versions will be included.

Output 3 channels
#1 log
emit: string

The standard output (stdout) of the script, containing log messages. You can print the last log to see the download progress of all the datasets. Example: METASPACE_DOWNLOAD.out.log.view { "${it.split('\n').last().trim()}" } It will print the last log message of the script. For Example: "❌ {dataset_id} Dataset not found or inaccessible. Skipping this dataset." "❌ {dataset_id} could not find database: {database}" "❌ {dataset_id} has no annotation data in database: {database}." "⚠️ {dataset_id} has multiple {database} version. All the version saved to {filename}" "✅ {dataset_id} with {database} database are saved to {filename}" "✅ {dataset_id} with all database are saved to {filename}"

#2 results
${dataset_id}_*.csv file

CSV file containing the downloaded dataset results, saved to the directory specified by the output parameter. Filename format is '{dataset_id}_*.csv'.

*.csv
#3 versions
versions.yml file

YAML file containing the versions of the tools used in the pipeline. This file is automatically generated by the pipeline and should not be modified.

versions.yml
Tool Description Homepage
metaspace2020 Python package providing programmatic access to the METASPACE platform https://metaspace2020.readthedocs.io
Version 0.0.0-6c4ed3a
Commit ID 6c4ed3a220310b905a1fc9d04f05be2e0837142b
Release Date 23 Apr 2026 15:30:25 (UTC)
Download URL https://registry.nextflow.io/api/v1/modules/nf-core%2Fmetaspace%2Fdownload/0.0.0-6c4ed3a/download
OCI Store URL https://public.cr.seqera.io/v2/nextflow/plugin/modules/nf-core/metaspace/download/blobs/sha256:5f923adf449b2684fc5ec7fc8cda4462b70652e8109bdf3c6865cacd970751ca
Size 5.2 KB
Checksum sha256:5f923adf449b2684fc5ec7fc8cda4462b70652e8109bdf3c6865cacd970751ca
Downloads 4
Version Date Status Downloads Size
0.0.0-6c4ed3a 23 Apr 2026 15:30:25 (UTC) 4 5.2 KB
0.0.0-0c7146d 08 Apr 2026 19:17:41 (UTC) 2 5.2 KB