datalad create-sibling-osf

Synopsis

datalad create-sibling-osf [-h] [--title TITLE] [-s NAME] [--storage-name NAME] [-d DATASET] [--mode {annex|export|exportonly|gitonly}] [--existing MODE] [--trust-level TRUST-LEVEL] [--tag TAG] [--public] [--category {analysis|communication|data|hypothesis|instrumentation|methods and measures|procedure|project|software|other}] [--description TEXT] [--version]

Description

Create a dataset representation at OSF.

This will create a node on OSF and initialize an osf special remote to point to it. There are two modes this can operate in: ‘annex’ and ‘export’. The former uses the OSF node as a key-value store, that can be used by git-annex to copy data to and retrieve data from (potentially by any clone of the original dataset). The latter allows to use ‘git annex export’ to publish a snapshot of a particular version of the dataset. Such an OSF node will - in opposition to the ‘annex’ - be human-readable.

For authentication with OSF, you can define environment variables: Either ‘OSF_TOKEN’, or both ‘OSF_USERNAME’ and ‘OSF_PASSWORD’. If neither of these is defined, the tool will fall back to the datalad credential manager and inquire for credentials interactively.

Options

-h, --help, --help-np

show this help message. –help-np forcefully disables the use of a pager for displaying the help message

--title TITLE

title of the to-be created OSF node that is displayed on the OSF website. Defaults to the basename of the root directory of the local dataset. Constraints: value must be a string

-s NAME, --name NAME

Name of the to-be initialized osf-special-remote. Constraints: value must be a string [Default: ‘osf’]

--storage-name NAME

Name of the storage sibling (git-annex special remote). Must not be identical to the sibling name. If not specified, defaults to the sibling name plus ‘-storage’ suffix. Constraints: value must be a string

-d DATASET, --dataset DATASET

Dataset to create a sibling for. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path)

--mode {annex|export|exportonly|gitonly}

Constraints: value must be one of (‘annex’, ‘export’, ‘exportonly’, ‘gitonly’) [Default: ‘annex’]

--existing MODE

Action to perform, if a (storage) sibling is already configured under the given name and/or a target already exists. In this case, a dataset can be skipped (‘skip’), or the command be instructed to fail (‘error’). Constraints: value must be one of (‘skip’, ‘error’) [Default: ‘error’]

--trust-level TRUST-LEVEL

specify a trust level for the storage sibling. If not specified, the default git-annex trust level is used. Constraints: value must be one of (‘trust’, ‘semitrust’, ‘untrust’)

--tag TAG

specific one or more tags for the to-be-create OSF node. A tag ‘DataLad dataset’ and the dataset ID (if there is any) will be automatically added as additional tags. This option can be given more than once.

--public

make OSF node public.

--category {analysis|communication|data|hypothesis|instrumentation|methods and measures|procedure|project|software|other}

specific the OSF node category to be used for the node. The categorization determines what icon is displayed with the node on the OSF, and helps with search organization. Constraints: value must be one of (‘analysis’, ‘communication’, ‘data’, ‘hypothesis’, ‘instrumentation’, ‘methods and measures’, ‘procedure’, ‘project’, ‘software’, ‘other’) [Default: ‘data’]

--description TEXT

Description of the OSF node that will be displayed on the associated project page. By default a description will be generated based on the mode the sibling is put into. Constraints: value must be a string

--version

show the module and its version which provides the command

Authors

datalad is developed by The DataLad Team and Contributors <team@datalad.org>.