Run BIDS validation on the project BIDS directory — run_bids

BIDS validation is configured with the project but submitted separately through this function. It is not a run_project() stage and can be invoked whenever validation of the project BIDS directory is desired.

Usage

run_bids_validation(scfg, outfile = NULL, wait_jobs = NULL, sequence_id = NULL)

Arguments

scfg: A bg_project_cfg object returned by setup_project() or load_project().
outfile: The output HTML report path for bids-validator. Relative paths are written under scfg$metadata$log_directory (to avoid contaminating the BIDS dataset); absolute paths are used as provided. If NULL, the value stored in scfg$bids_validation$outfile is used.
wait_jobs: Optional character vector of upstream scheduler job IDs that must complete before this validation job starts.
sequence_id: Optional sequence ID used for job tracking.

Value

The job id returned by the scheduler.

Examples

if (FALSE) { # \dontrun{
  run_bids_validation(study_config, outfile = "bids_validator_output.html")
} # }