fsbrain (version 0.0.2)

subject.filepath.any: Construct filepath of any freesurfer file.

Description

Construct filepath of any freesurfer file.

Usage

subject.filepath.any(subjects_dir, subject_id, relative_path_parts,
  hemi = NULL, file_tag = "", warn_if_nonexistent = FALSE)

Arguments

subjects_dir,

string. The FreeSurfer SUBJECTS_DIR, i.e., a directory containing the data for all your subjects, each in a subdir named after the subject identifier.

subject_id,

string. The subject identifier

relative_path_parts,

vector of strings. THe path to the file, e.g., c("surf", "lh.area").

hemi,

string, one of 'lh', 'rh', or NULL. Defaults to NULL. If a hemisphere name is given, it is added as a prefix to the last entry in relative_path_parts, separated by a dot.

file_tag,

string. A one-word description of the file type that will show up in the error message to describe the file if it is missing. Leads to a better error message. Examples: 'morphometry' or 'label'. Only relevant if warn_if_nonexistent is TRUE. Defaults to the empty string.

warn_if_nonexistent,

logical. Whether to print a warning if the file does not exist or cannot be accessed. Defaults to FALSE.

Value

string, the file path.