bidsJson: Conversion to and from BIDS JSON

In RNifti: Fast R and C++ Access to NIfTI Images

Conversion to and from BIDS JSON

Description

Functions to convert to and from BIDS JSON format for image metadata. They are wrappers around functions from the jsonlite package, with the additional ability to convert between the tag naming convention used by the divest and tractor.base packages and the BIDS equivalent. The differences are mostly in capitalisation, and the units used for magnetic resonance echo, repetition and inversion times.

Usage

fromBidsJson(source, rename = FALSE)

toBidsJson(source, path = NULL, rename = FALSE)

Arguments

source	A list containing metadata (see imageAttributes) or, for fromBidsJson, a string containing literal JSON or the path to a file containing it.
rename	Logical value. If TRUE, element names are also converted to or from the BIDS convention; otherwise this is just a conversion between an R list and a JSON string.
path	For toBidsJson, the path to write the JSON output to. If NULL, the default, the JSON text is returned in an object.

Value

fromBidsJson returns a list of image attributes. toBidsJson returns a character vector if path is NULL, otherwise nothing.

Note

These functions do not check BIDS metadata for validity in either direction, either in terms of the names of the fields or their contents.

Author(s)

Jon Clayden <[e-mail]>

References

More information about metadata captured by the BIDS format can be found at https://bids.neuroimaging.io or in the paper cited below.

K.J. Gorgolewski, T. Auer, V.D. Calhoun, et al. The brain imaging data structure, a format for organizing and describing outputs of neuroimaging experiments (2016). Scientific Data 3:160044. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1038/sdata.2016.44")}.

RNifti documentation built on April 3, 2025, 5:57 p.m.