xnat_connection: Make a connection to an XNAT server

Description Usage Arguments Value Examples

Description

Make the XNAT connection and provides functions to retrieve the list of projects, experiments and subjects.

Usage

1
xnat_connect(base_url, username = NULL, password = NULL, xnat_name = NULL, ...)

Arguments

base_url

the URL for the XNAT server

username

user name to use for connection. If NULL this can be provided through the xxx_WEB_USER system variable where xxx is provided by the xnat_name parameter

password

user name to use for connection. If NULL this can be provided through the xxx_WEB_PASS system variable where xxx is provided by the xnat_name parameter

xnat_name

prefix to use for retrieving the proper username/pass system variables for a specific XNAT server

...

additional arguments passed to curlPerform.

Value

projects

Examples

1
2
3
4
5
## Connect to the NITRC.ORG database
## Not run: xnat_connect('https://nitrc.org/ir', xnat_name='NITRC')

## Connect to the XNAT.CENTRAL database
## Not run: xnat_connect('https://central.xnat.org', xnat_name="CENTRAL")

Rxnat documentation built on Aug. 19, 2021, 5:06 p.m.