datasets¶

This section is auto-generated from the help text for the parsec command datasets.

`download_dataset` command¶

Usage:

parsec datasets download_dataset [OPTIONS] DATASET_ID

Help

Download a dataset to file or in memory. If the dataset state is not ‘ok’, a DatasetStateException will be thrown.

Output

If a file_path argument is not provided, returns a dict containing the file_content.

Otherwise returns nothing.

Options:

--file_path TEXT        If this argument is provided, the dataset will be
                        streamed to disk at that path (should be a directory
                        if use_default_filename=True). If the file_path
                        argument is not provided, the dataset content is
                        loaded into memory and returned by the method (Memory
                        consumption may be heavy as the entire file will be in
                        memory).
--use_default_filename  If this argument is True, the exported file will be
                        saved as file_path/%s, where %s is the dataset name.
                        If this argument is False, file_path is assumed to
                        contain the full file path including the filename.
                        [default: True]
--wait_for_completion   This parameter is deprecated and ignored, it will be
                        removed in BioBlend 0.12.  [default: True]
--maxwait FLOAT         Total time (in seconds) to wait for the dataset state
                        to become terminal. If the dataset state is not
                        terminal within this time, a
                        ``DatasetTimeoutException`` will be thrown.  [default:
                        12000]
-h, --help              Show this message and exit.

`show_dataset` command¶