Class BidsSidecar

constructor

• new BidsSidecar(
      name: string,
      file: any,
      sidecarData?: any,
      defManager?: DefinitionManager,
  ): BidsSidecar

  Constructor for a BIDS sidecar. Used for files like events.json, participants.json, etc.

  Parameters

  • name: string

    The name of the sidecar file.
  • file: any

    The file object representing this file.
  • sidecarData: any = {}

    The raw JSON data.
  • defManager: DefinitionManager = undefined

    The external definitions to use.

  Returns BidsSidecar

columnSpliceMapping

columnSpliceReferences

definitions

hedCategoricalStrings

hedData

hedValueStrings

parsedHedData

sidecarKeys

hasHedData

• get hasHedData(): boolean

  Determine whether this file has any HED data.

  Returns boolean

parseHed

• parseHed(hedSchemas: Schemas, fullValidation?: boolean): any[]

  Parse this sidecar's HED strings within the sidecar structure.

  The parsed strings are placed into parsedHedData.

  Parameters

  • hedSchemas: Schemas

    The HED schema collection.
  • fullValidation: boolean = false

    True if full validation should be performed.

  Returns any[]

  [Issue[], Issue[]] Any errors and warnings found

StaticcreateFromBidsDatasetPath

• createFromBidsDatasetPath(
      datasetRoot: string,
      relativePath: string,
  ): Promise<BidsSidecar>

  Parse a BIDS sidecar from a BIDS dataset path.

  Parameters

  • datasetRoot: string

    The root path of the dataset.
  • relativePath: string

    The relative path of the file within the dataset.

  Returns Promise<BidsSidecar>

  The built sidecar object.