datalad xnat-query-files

Synopsis

datalad xnat-query-files [-h] [-p ID] [-e ID] [-s ID] [--credential NAME] [--version] url

Description

Query an XNAT server for projects, or an XNAT project for subjects

Use this command to get a list of available projects at an XNAT instance for a given URL, or to get a list of subjects inside a specific project at the given XNAT instance.

Examples

Get a list of projects for a given XNAT instance::

% datalad xnat-query http://central.xnat.org:8080

Get a list of subject for a given XNAT project::

% datalad xnat-query http://central.xnat.org:8080 -p myproject

Options

url

XNAT instance URL to query.

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

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

-p ID, --project ID

accession ID of a single XNAT project to track.

-e ID, --experiment ID

accession ID of a single experiment to track.

-s ID, --subject ID

accession ID of a single subject to track.

--credential NAME

name of the credential providing a user/password combination to be used for authentication. The special value 'anonymous' will cause no credentials to be used, and all XNAT requests to be performed anonymously. The credential can be supplied via configuration settings 'datalad.credential.<name>.{user|password}', or environment variables DATALAD_CREDENTIAL_<NAME>_{USER|PASSWORD}, or will be queried from the active credential store using the provided name. If none is provided, the host-part of the XNAT URL is used as a name (e.g. 'https://central.xnat.org' -> 'central.xnat.org'). Constraints: value must be a string or value must be NONE

--version

show the module and its version which provides the command

Authors

datalad is developed by Michael Hanke <michael.hanke@gmail.com>.