Parse BIDS entities from paths into a tibble

bids_entities() is the vectorized counterpart to encode(). It accepts a character vector of full paths or bare filenames and returns one row per input path with the union of parsed BIDS entity columns.

Usage

bids_entities(paths, include_path = TRUE, coerce = TRUE)

Arguments

paths

Character vector of paths or filenames.

include_path

Logical. If TRUE (default), include a .path column containing the original input.

coerce

Logical. If TRUE (default), coerce numeric BIDS entities such as run and echo to integer when possible.

Value

A tibble with one row per input path. Missing entities are NA. In addition to BIDS entities, rows include extension (the complete file extension, including compound extensions such as .nii.gz) and datatype when it can be inferred from a registered datatype folder.

Examples

bids_entities(c(
  "sub-01_task-rest_run-01_bold.nii.gz",
  "sub-01_task-rest_run-02_bold.nii.gz"
))
#> # A tibble: 2 × 9
#>   .path                  subid task    run kind  suffix type  extension datatype
#>   <chr>                  <chr> <chr> <int> <chr> <chr>  <chr> <chr>     <chr>   
#> 1 sub-01_task-rest_run-… 01    rest      1 bold  nii.gz func  .nii.gz   NA      
#> 2 sub-01_task-rest_run-… 01    rest      2 bold  nii.gz func  .nii.gz   NA