cubids.workflows.apply

apply(bids_dir, use_datalad, acq_group_level, config, schema, edited_summary_tsv, files_tsv, new_tsv_prefix, n_cpus=1, allow_fmap_renames=False, change_rename_entity_set=None, remove_rename_entity_set=None, write_edited_summary=None)[source]

Apply the tsv changes.

Parameters:

  • bids_dir (pathlib.Path) – Path to the BIDS directory.

  • use_datalad (bool) – Use datalad to track changes.

  • acq_group_level ({"subject", "session"}) – Level at which acquisition groups are created.

  • config (pathlib.Path) – Path to the grouping config file.

  • schema (pathlib.Path) – Path to the BIDS schema file.

  • edited_summary_tsv (pathlib.Path) – Path to the edited summary tsv.

  • files_tsv (pathlib.Path) – Path to the files tsv.

  • new_tsv_prefix (pathlib.Path) – Path to the new tsv prefix.

  • allow_fmap_renames (bool) – Allow fieldmap renames after validating related fieldmap collections.

  • change_rename_entity_set (list[str] or None) – Exact entity set substitutions in OLD=NEW form or paths to CSV/TSV mapping tables with old_entity_set and new_entity_set columns.

  • remove_rename_entity_set (list[str] or None) – Exact entity sets whose matching parameter groups are deleted, or paths to CSV/TSV tables with an entity_set column.

  • write_edited_summary (pathlib.Path or None) – Destination for the edited summary.tsv file.