bids.reports.BIDSReport¶
- class BIDSReport(layout, config=None)[source]¶
Generates publication-quality data acquisition methods section from BIDS dataset.
- Parameters
layout (
bids.layout.BIDSLayout
) – Layout object for a BIDS dataset.config (
str
ordict
, 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)
Methods
generate
(**kwargs)Generate the methods section.
generate_from_files
(files)Generate a methods section from a list of files.
- __init__(layout, config=None)[source]¶
Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
(layout[, config])Initialize self.
generate
(**kwargs)Generate the methods section.
generate_from_files
(files)Generate a methods section from a list of files.