download_xnat_dir: Download XNAT directory

Description Usage Arguments Value Examples

View source: R/xnat_api.R

Description

Download a full directory of data

Usage

1

Arguments

conn

The XNAT connection returned by a xnat_connect call

...

experiment_ID the experiment Id for which we need to download data scan_type type of image scan zipped zip the downloaded result verbose Should progress be added to download? error Should function error if download failed? extract Unzip the result and return the files list (based on scan_type)

Value

Display path to the downloaded file

Examples

1
2
3
4
5
6
7
8
## Not run: nitrc <- xnat_connect('https://nitrc.org/ir', xnat_name='NITRC')
## Not run: download_xnat_dir(nitrc, 
                           experiment_ID='NITRC_IR_E10507',
                           scan_type='T2', 
                           file_dir = tempdir(),
                           extract = TRUE)

## End(Not run)

adigherman/Rxnat documentation built on Oct. 7, 2021, 2:53 p.m.