BIDSDatasetGeneratedBy {bidsr} | R Documentation |
Class definition for 'BIDS' meta-data 'GeneratedBy'
Description
See definition at https://bids-specification.readthedocs.io/en/stable/glossary.html#objects.metadata.GeneratedBy
Usage
BIDSDatasetGeneratedBy(
Name = character(0),
Version = character(0),
Description = character(0),
CodeURL = character(0),
Container = list()
)
Arguments
Name |
(character, required) name of the pipeline or process that generated the outputs. |
Version |
(character, optional) version of the pipeline |
Description |
(character, optional) plain-text description of the pipeline or process that generated the outputs. |
CodeURL |
(character, optional) 'URL' where the code used to generate the data may be found. |
Container |
(character, optional) Used to specify the location and
relevant attributes of software container image used to produce the data.
Valid keys in this object include type, tag 'URL' with string values.
Package |
Value
Instantiated object of class BIDSDatasetGeneratedBy
Author(s)
Zhengjia Wang
Examples
x <- BIDSDatasetGeneratedBy(
Name = "RAVE Team",
Version = "0.0.1",
Container = list(
Type = "docker",
Tag = "rave-ieeg/rave-pipelines:0.0.1"
)
)
x
x$Version <- "0.0.2"
# convert to basic list
as.list(x)
# get JSON string
format(x)
[Package bidsr version 0.1.1 Index]