Package: xnatR 0.2.0

xnatR: Interface with XNAT Systems

An R package for interacting with XNAT systems via the REST API. Provides functions to authenticate, list projects/subjects/experiments/scans, search, and download data from XNAT neuroimaging archives.

Authors:Bradley Buchsbaum [aut, cre]

xnatR_0.2.0.tar.gz
xnatR_0.2.0.zip(r-4.7)xnatR_0.2.0.zip(r-4.6)xnatR_0.2.0.zip(r-4.5)
xnatR_0.2.0.tgz(r-4.6-any)xnatR_0.2.0.tgz(r-4.5-any)
xnatR_0.2.0.tar.gz(r-4.7-any)xnatR_0.2.0.tar.gz(r-4.6-any)
xnatR_0.2.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION
card.svg |card.png
xnatR/json (API)

# Install 'xnatR' in R:
install.packages('xnatR', repos = c('https://bbuchsbaum.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/bbuchsbaum/xnatr/issues

On CRAN:

Conda:

3.78 score 5 scripts 46 exports 20 dependencies

Last updated from:6e59d77b7a. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK149
source / vignettesOK184
linux-release-x86_64OK164
macos-release-arm64OK98
macos-oldrel-arm64OK114
windows-develOK97
windows-releaseOK79
windows-oldrelOK85
wasm-releaseOK104

Exports:authenticate_xnatdicom_dumpdownload_experimentdownload_filesdownload_subjectdownload_xnat_fileinitialize_configinstall_cliis_authenticatedlist_assessorslist_data_typeslist_experiment_fileslist_experiment_files_alllist_experiment_resourceslist_experimentslist_fileslist_projectslist_queryable_fieldslist_recent_sessionslist_reconstructionslist_resourceslist_scanslist_subjectssearch_criterionsearch_executesearch_projectssearch_scanssearch_selectsearch_wherewith_xnat_clientxnat_browse_projectsxnat_browse_subjectsxnat_clientxnat_connectxnat_current_clientxnat_explorexnat_logoutxnat_searchxnat_search_builderxnat_serverxnat_token_invalidatexnat_token_issuexnat_token_listxnat_token_validatexnat_usernamexnatR_cli

Dependencies:askpassclicurlgluehttr2jsonlitelifecyclemagrittropensslpillarpkgconfigR6rappdirsrlangsystibbleutf8vctrswithryaml

Common Workflows
Find recent sessions and download three subjects | Search for sessions by date range | Find scans by acquisition parameters | Browse files before downloading | Build a local inventory of a project | Use alias tokens for shared scripts | Clean up

Last update: 2026-03-30
Started: 2026-03-30

Getting Started with xnatR
Connect and explore in 30 seconds | The XNAT data hierarchy | How do I find my project? | Who is in the project? | What sessions exist? | What scans are in a session? | How do I download data? | Download all scans from a session | Download specific scans or resource types | Download an entire subject | Download a session by experiment ID alone | Credential management | Clean up | Next steps

Last update: 2026-03-30
Started: 2026-02-02

Readme and manuals

Help Manual

Help pageTopics
Authenticate with an XNAT Serverauthenticate_xnat
Dump DICOM header fields for a session or scandicom_dump
Download an Experiment Archivedownload_experiment
Download Files from XNATdownload_files
Download All Data for a Subjectdownload_subject
Download a Single File from XNATdownload_xnat_file
Initialize Configuration Fileinitialize_config
Install the xnatR command-line wrapperinstall_cli
Check if authenticatedis_authenticated
List Assessors for an Experimentlist_assessors
List Available Data Typeslist_data_types
List Files in an Experiment Resourcelist_experiment_files
List All Files for an Experimentlist_experiment_files_all
List Resources for an Experimentlist_experiment_resources
List Experiments (Sessions) for a Project or Subjectlist_experiments
List Files in a Resourcelist_files
List XNAT Projectslist_projects
List Queryable Fields for a Data Typelist_queryable_fields
List Recent Sessions for a Projectlist_recent_sessions
List Reconstructions for an Experimentlist_reconstructions
List Resources for a Scanlist_resources
List Scans for an Experimentlist_scans
List Subjects in a Projectlist_subjects
Create a Search Criterionsearch_criterion
Execute Search Builder Querysearch_execute
Search XNAT Projectssearch_projects
Search Scans Across XNATsearch_scans
Add Fields to Search Buildersearch_select
Add Criterion to Search Buildersearch_where
Temporarily use a client as the global sessionwith_xnat_client
Interactive browsing helpersxnat_browse
Browse projects interactivelyxnat_browse_projects
Browse subjects interactivelyxnat_browse_subjects
Create an 'xnat_client'xnat_client
XNAT client objectsxnat_connect
Get the current global-session clientxnat_current_client
Explore XNAT interactively with fzfxnat_explore
Log out from XNATxnat_logout
Search XNAT Dataxnat_search
Search Builder - Fluent Interfacexnat_search_builder
Get current XNAT server URLxnat_server
Invalidate an Alias Tokenxnat_token_invalidate
Issue an Alias Tokenxnat_token_issue
List User's Alias Tokensxnat_token_list
Validate an Alias Tokenxnat_token_validate
Get current usernamexnat_username
Command-line interface for xnatRxnatR_cli