Fork me on GitHub

get-unite-data: Download and import UNITE reference data.

Citations

Docstring:

Usage: qiime rescript get-unite-data [OPTIONS]

  Download and import ITS sequences and taxonomy from the UNITE database,
  given a version number and taxon_group, with the option to select a
  cluster_id and include singletons. Downloads data directly from UNITE's
  PlutoF REST API. NOTE: THIS ACTION ACQUIRES DATA FROM UNITE, which is
  licensed under CC BY-SA 4.0. To learn more, please visit
  https://unite.ut.ee/cite.php and https://creativecommons.org/licenses/by-
  sa/4.0/.

Parameters:
  --p-version TEXT Choices('10.0', '9.0', '8.3', '8.2')
                          UNITE version to download.         [default: '10.0']
  --p-taxon-group TEXT Choices('fungi', 'eukaryotes')
                          Download a database with only 'fungi' or including
                          all 'eukaryotes'.            [default: 'eukaryotes']
  --p-cluster-id TEXT Choices('99', '97', 'dynamic')
                          Percent similarity at which sequences in the of
                          database were clustered.             [default: '99']
  --p-singletons / --p-no-singletons
                          Include singleton clusters in the database.
                                                              [default: False]
Outputs:
  --o-taxonomy ARTIFACT FeatureData[Taxonomy]
                          UNITE reference taxonomy.                 [required]
  --o-sequences ARTIFACT FeatureData[Sequence]
                          UNITE reference sequences.                [required]
Miscellaneous:
  --output-dir PATH       Output unspecified results to a directory
  --verbose / --quiet     Display verbose output to stdout and/or stderr
                          during execution of this action. Or silence output
                          if execution is successful (silence is golden).
  --example-data PATH     Write example data and exit.
  --citations             Show citations and exit.
  --use-cache DIRECTORY   Specify the cache to be used for the intermediate
                          work of this action. If not provided, the default
                          cache under $TMP/qiime2/ will be used.
                          IMPORTANT FOR HPC USERS: If you are on an HPC system
                          and are using parallel execution it is important to
                          set this to a location that is globally accessible
                          to all nodes in the cluster.
  --help                  Show this message and exit.

Import:

from qiime2.plugins.rescript.methods import get_unite_data

Docstring:

Download and import UNITE reference data.

Download and import ITS sequences and taxonomy from the UNITE database,
given a version number and taxon_group, with the option to select a
cluster_id and include singletons. Downloads data directly from UNITE's
PlutoF REST API. NOTE: THIS ACTION ACQUIRES DATA FROM UNITE, which is
licensed under CC BY-SA 4.0. To learn more, please visit
https://unite.ut.ee/cite.php and https://creativecommons.org/licenses/by-
sa/4.0/.

Parameters
----------
version : Str % Choices('10.0', '9.0', '8.3', '8.2'), optional
    UNITE version to download.
taxon_group : Str % Choices('fungi', 'eukaryotes'), optional
    Download a database with only 'fungi' or including all 'eukaryotes'.
cluster_id : Str % Choices('99', '97', 'dynamic'), optional
    Percent similarity at which sequences in the of database were
    clustered.
singletons : Bool, optional
    Include singleton clusters in the database.

Returns
-------
taxonomy : FeatureData[Taxonomy]
    UNITE reference taxonomy.
sequences : FeatureData[Sequence]
    UNITE reference sequences.