BIDSEntity {bidsr} | R Documentation |
Class definitions of 'BIDS' entity
Description
A 'BIDS' entity is an attribute that can be associated with a file, contributing to the identification of that file as a component of its file-name in the form of a hyphen-separated key-value pair. The specification can be found at https://bids-specification.readthedocs.io/en/stable/common-principles.html#entities.
Usage
BIDSEntity_label_required(
key = character(0),
value = character(0),
index_format = "%d"
)
BIDSEntity_label_optional(
key = character(0),
value = character(0),
index_format = "%d"
)
BIDSEntity_label_prohibited(
key = character(0),
value = character(0),
index_format = "%d"
)
BIDSEntity_index_required(
key = character(0),
value = integer(0),
index_format = "%d"
)
BIDSEntity_index_optional(
key = character(0),
value = integer(0),
index_format = "%d"
)
BIDSEntity_index_prohibited(
key = character(0),
value = integer(0),
index_format = "%d"
)
BIDSEntity_any_required(
key = character(0),
value = character(0),
index_format = "%d"
)
BIDSEntity_any_optional(
key = character(0),
value = character(0),
index_format = "%d"
)
BIDSEntity_any_prohibited(
key = character(0),
value = character(0),
index_format = "%d"
)
Arguments
key |
(string, required) A short string, typically a compression of the entity name, which uniquely identifies the entity when part of a file-name. |
value |
A string (label) or a non-negative integer (index); the requisite form of the value that gets specified alongside the key whenever the entity appears in a file-name. For each entity, the value is of one of two possible types: |
index_format |
for index entities, how to format index values (e.g. padding zeros) when formatted as string; default is without padding
|
Value
A 'BIDS' entity object.
Author(s)
Zhengjia Wang
Examples
entity_int <- BIDSEntity_index_optional(key = "run", value = "001")
entity_int$value <- integer()
print(entity_int) # nothing will be printed out
# subject entity
entity_subject <- BIDSEntity_any_required(key = "sub", value = "HUP225")
print(entity_subject)
# index
entity_subject$value <- 1
print(entity_subject)
# format index
entity_subject$index_format <- "%03d"
print(entity_subject)
# trying to set invalid values will result in errors
try({
BIDSEntity_index_required(key = "run")
})
entity_int <- BIDSEntity_index_required(key = "run", value = "001")
# trying to unset require entity
try({
entity_int$value <- integer()
})
# trying to set invalid entity
try({
entity_int$value <- "asdad"
})
# trying to set prohibited entiry
try({
BIDSEntity_index_prohibited("invalid", 123)
})