About

ancpBIDS is a lightweight Python library to read/query/validate/write BIDS datasets. It can be used in workflows or analysis pipelines to handle IO specific aspects without bothering much about low level file system operations. Its implementation is based on the BIDS schema and allows it to evolve with the BIDS specification in a generic way. Using a plugin mechanism, contributors can extend its functionality in a controlled and clean manner.

!!! ANNOUNCEMENT !!! As of version 0.22.0 the BIDSLayout has moved over to PyBIDS where it will be developed and maintained in future. ancpBIDS itself does not support this interface anymore but will act as a core package to PyBIDS and downstream projects needing a lightweight IO library to handle BIDS datasets. This documentation has not yet been updated to reflect this change.

• Installation
  • Install using pip
  • Install using conda
• User Documentation
  • Querying information about a BIDS dataset
    • Load an existing BIDS dataset
    • Perform some basic queries
    • Querying for metadata
    • Retrieving matching filenames
• Advanced Queries
  • Querying metadata and other descriptive files
• Validating a BIDS dataset
• API
  • DatasetOptions
    • DatasetOptions.ignore
    • DatasetOptions.infer_artifact_datatype
  • load_dataset()
  • load_schema()
  • save_dataset()
  • validate_dataset()
  • write_derivative()
  • deepupdate()
  • fetch_dataset()
  • load_contents()
  • parse_bids_name()
  • write_contents()
  • DatasetPlugin
  • FileHandlerPlugin
  • Plugin
  • SchemaPlugin
  • ValidationPlugin
    • ValidationPlugin.ValidationReport
      • ValidationPlugin.ValidationReport.error()
      • ValidationPlugin.ValidationReport.has_errors()
      • ValidationPlugin.ValidationReport.warn()
  • WritingPlugin
  • get_plugins()
  • is_valid_plugin()
  • load_plugins_by_package()
  • register_plugin()