Skip to content

operations

import.file

Documentation

A generic module that imports a file from one of several possible sources.

Inputs
field name type description required default
source string The source uri of the file to be onboarded. yes
file_name string The file name to use for the onboarded file (defaults to source file name if possible). no
attach_metadata boolean Whether to attach onboarding metadata to the result file. no True
onboard_type string The type of onboarding to use. Allowed: github, local_file, url, zenodo no
Outputs
field name type description required default
file file The file that was onboarded. yes

import.file_bundle

Documentation

A generic module that imports a file from one of several possible sources.

Inputs
field name type description required default
source string The source uri of the file to be onboarded. yes
attach_metadata boolean Whether to attach onboarding metadata. no True
sub_path string The sub path to use. If not specified, the root of the source folder will be used. no
include_files list Include files that end with one of those tokens. If not specified, all file extensions are included. no
exclude_files list Exclude files that end with one of those tokens. If not specified, no file extensions are excluded. no
exclude_dirs list Exclude directories that end with one of those tokens. If not specified, no directories are excluded. no
onboard_type string The type of onboarding to use. Allowed: github, local_file, url, zenodo no
Outputs
field name type description required default
file_bundle file_bundle The file_bundle that was onboarded. yes

onboard.zenodo_record

Documentation

Download a dataset from zenodo.org.

Inputs
field name type description required default
doi string The doi of the record yes
include_metadata boolean Whether to write the record metadata to a file 'metadata.json' and include it in the resulting file bundle. no True
Outputs
field name type description required default
file_bundle file_bundle -- n/a -- yes