Skip to contents

Create a lightweight text report for a BIDS project

Source: R/project_extensions.R
bids_report.Rd

Create a lightweight text report for a BIDS project

Usage

bids_report(x, ...)

Arguments

x

A bids_project object.

...

Additional arguments passed to bids_report_data().

Value

An object of class bids_report.

Examples

# \donttest{
tryCatch({
  ds001_path <- get_example_bids_dataset("ds001")
  proj <- bids_project(ds001_path)
  rpt <- bids_report(proj)
  print(rpt)
  # Example datasets are cached; leave the cache in place.
}, error = function(e) message("Example requires internet: ", e$message))
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> Project does not have fmriprep derivatives enabled. Cannot search for confound files.
#> BIDS Report
#> Project: bids_example_ds001 
#> Participants source: file 
#> Subjects: 16 
#> Sessions: 0 
#> Tasks: balloonanalogrisktask 
#> Total runs: 3 
#> Compliance: passed 
#> Index: available 
#> Indexed runs: 48 
# }