Class BidsTsvFile

A BIDS TSV file.

Hierarchy (View Summary)

BidsFile
- BidsTsvFile

Index

Constructors

Properties

file hedColumnHedStrings mergedSidecar name parsedTsv

Accessors

hasHedData isTimelineFile validatorClass

Methods

validate readBidsFile readBidsFileFromDatasetPath

Constructors

constructor

new BidsTsvFile(
    name: any,
    file: any,
    tsvData: any,
    mergedDictionary?: {},
    defManager?: any,
): BidsTsvFile
Parameters
- name: any
- file: any
- tsvData: any
- mergedDictionary: {} = {}
- defManager: any = undefined
Returns BidsTsvFile
Overrides BidsFile.constructor
- Defined in src/bids/types/tsv.js:36

Properties

file

file: any

The Object representing this file data. This is used to generate BidsHedIssue objects.

hedColumnHedStrings

hedColumnHedStrings: string[]

HED strings in the "HED" column of the TSV data.

mergedSidecar

mergedSidecar: BidsSidecar

The pseudo-sidecar object representing the merged sidecar data.

name

name: string

The name of this file.

parsedTsv

parsedTsv: Map<string, string[]>

This file's parsed TSV data.

Accessors

hasHedData

get hasHedData(): boolean
Determine whether this file has any HED data.

Returns boolean
Overrides BidsFile.hasHedData
- Defined in src/bids/types/tsv.js:72

isTimelineFile

get isTimelineFile(): boolean
Whether this TSV file is a timeline file.

Returns boolean
Overrides BidsFile.isTimelineFile
- Defined in src/bids/types/tsv.js:81

validatorClass

get validatorClass(): Function
The validator class used to validate this file.

Returns Function
The validator class used to validate this file.
Inherited from BidsFile.validatorClass
- Defined in src/bids/types/file.js:119

Methods

validate

validate(schemas: Schemas): BidsHedIssue[]
Validate this validator's tsv file.
Parameters
- schemas: Schemas
  The HED schemas used to validate this file.
Returns BidsHedIssue[]
- Any issues found during validation of this TSV file.
Inherited from BidsFile.validate
- Defined in src/bids/types/file.js:71

`Static`readBidsFile

readBidsFile(filePath: string): Promise<any[]>
Read a BIDS file from a path.
Parameters
- filePath: string
  The actual path of the file.
Returns Promise<any[]>
A Promise that resolves to a two-element array containing the file contents and a mocked BIDS-type file object.
Inherited from BidsFile.readBidsFile
- Defined in src/bids/types/file.js:60

`Static`readBidsFileFromDatasetPath

readBidsFileFromDatasetPath(
datasetRoot: string,
relativePath: string,
): Promise<any[]>
Read a BIDS file from a relative path within a dataset.
Parameters
- datasetRoot: string
  The root path of the dataset.
- relativePath: string
  The relative path of the file within the dataset.
Returns Promise<any[]>
A Promise that resolves to a two-element array containing the file contents and a mocked BIDS-type file object.
Inherited from BidsFile.readBidsFileFromDatasetPath
- Defined in src/bids/types/file.js:48