Skip to contents

Wraps wb_command -file-information to list information about a data file's content.

Usage

file_information(
  data_file,
  only_map_names = FALSE,
  only_number_of_maps = FALSE,
  only_metadata = FALSE,
  only_cifti_xml = FALSE,
  verbose = get_wb_verbosity()
)

Arguments

data_file

Path to the input file.

only_map_names

Logical; show only map names?

only_number_of_maps

Logical; show only number of maps?

only_metadata

Logical; show only metadata?

only_cifti_xml

Logical; show only CIFTI XML (CIFTI files only)?

verbose

Logical; print command output?

Value

Character vector of information lines, invisibly.

Examples

if (FALSE) { # \dontrun{
file_information("data.dscalar.nii")
file_information("data.dscalar.nii", only_map_names = TRUE)
} # }