bids.reports.BIDSReport

class BIDSReport(layout, config=None)

Generate publication-quality data acquisition section from BIDS dataset.

Parameters:

• layout (bids.layout.BIDSLayout) – Layout object for a BIDS dataset.

• config (str or dict, optional) –

  Configuration info for methods generation. Can be a path to a file (str), a dictionary, or None. If None, loads and uses default configuration information. Keys in the dictionary include:

  ’dir’: a dictionary for converting encoding direction strings

  (e.g., j-) to descriptions (e.g., anterior to posterior)

  ’seq’: a dictionary of sequence abbreviations (e.g., EP) and

  corresponding names (e.g., echo planar)

  ’seqvar’: a dictionary of sequence variant abbreviations

  (e.g., SP) and corresponding names (e.g., spoiled)

Warning

pybids’ automatic report generation is experimental and currently under active development, and as such should be used with caution. Please remember to verify any generated report before putting it to use.

Additionally, only MRI datatypes (func, anat, fmap, and dwi) are currently supported.

Methods

generate(**kwargs)	Generate the methods section.
generate_from_files(files)	Generate a methods section from a list of files.

__init__(layout, config=None)

Methods

__init__(layout[, config])
generate(**kwargs)	Generate the methods section.
generate_from_files(files)	Generate a methods section from a list of files.