Skip to content

Commit 247f497

Browse files
committed
Updated the documentation
1 parent 2794cb2 commit 247f497

42 files changed

Lines changed: 41692 additions & 286 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/api/errors.md

Lines changed: 71 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,54 +4,113 @@ Error handling and exception classes for HED validation and processing.
44

55
## Exception Classes
66

7+
Core exception classes for HED-related errors.
8+
79
### HedFileError
810

911
::: hed.errors.exceptions.HedFileError
1012
options:
11-
show_source: true
13+
show_source: false
14+
heading_level: 4
1215

1316
### HedExceptions
1417

1518
::: hed.errors.exceptions.HedExceptions
1619
options:
17-
show_source: true
20+
show_source: false
21+
heading_level: 4
1822

1923
## Error Reporting
2024

25+
Classes for collecting, managing, and reporting validation errors.
26+
2127
### ErrorHandler
2228

2329
::: hed.errors.error_reporter.ErrorHandler
2430
options:
25-
show_source: true
31+
show_source: false
32+
heading_level: 4
33+
34+
### Error Reporting Functions
35+
36+
::: hed.errors.error_reporter.get_printable_issue_string
37+
options:
38+
show_source: false
39+
heading_level: 4
40+
41+
::: hed.errors.error_reporter.sort_issues
42+
options:
43+
show_source: false
44+
heading_level: 4
45+
46+
::: hed.errors.error_reporter.replace_tag_references
47+
options:
48+
show_source: false
49+
heading_level: 4
2650

2751
### ErrorContext
2852

2953
::: hed.errors.error_types.ErrorContext
3054
options:
31-
show_source: true
32-
33-
## Error Types
55+
show_source: false
56+
heading_level: 4
3457

3558
### ErrorSeverity
3659

3760
::: hed.errors.error_types.ErrorSeverity
3861
options:
39-
show_source: true
62+
show_source: false
63+
heading_level: 4
64+
65+
## Error Types
66+
67+
Specific error categories for different types of validation issues.
4068

4169
### ValidationErrors
4270

4371
::: hed.errors.error_types.ValidationErrors
4472
options:
45-
show_source: true
73+
show_source: false
74+
heading_level: 4
75+
76+
### SchemaErrors
77+
78+
::: hed.errors.error_types.SchemaErrors
79+
options:
80+
show_source: false
81+
heading_level: 4
82+
83+
### SchemaWarnings
84+
85+
::: hed.errors.error_types.SchemaWarnings
86+
options:
87+
show_source: false
88+
heading_level: 4
4689

4790
### SidecarErrors
4891

4992
::: hed.errors.error_types.SidecarErrors
5093
options:
51-
show_source: true
94+
show_source: false
95+
heading_level: 4
96+
97+
### ColumnErrors
98+
99+
::: hed.errors.error_types.ColumnErrors
100+
options:
101+
show_source: false
102+
heading_level: 4
103+
104+
### DefinitionErrors
105+
106+
::: hed.errors.error_types.DefinitionErrors
107+
options:
108+
show_source: false
109+
heading_level: 4
52110

53-
## Schema Error Messages
111+
### TemporalErrors
54112

55-
::: hed.errors.schema_error_messages
113+
::: hed.errors.error_types.TemporalErrors
56114
options:
57-
show_source: true
115+
show_source: false
116+
heading_level: 4

docs/api/index.md

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -7,64 +7,56 @@ This section provides comprehensive documentation for all HED Python tools modul
77
### [Models](models.md)
88
Core data models for working with HED data:
99

10-
- **HedString**: Represents and validates HED annotation strings
11-
- **HedTag**: Individual HED tag manipulation
12-
- **HedGroup**: Grouped HED annotations
13-
- **Sidecar**: BIDS sidecar file handling
14-
- **TabularInput**: Spreadsheet and tabular data processing
10+
- **Core Models**: HedString, HedTag, HedGroup, DefinitionDict, DefinitionEntry
11+
- **Input Models**: BaseInput, TabularInput, SpreadsheetInput, TimeseriesInput, Sidecar
12+
- **Query Models**: QueryHandler and query service functions
13+
- **Utility Models**: ColumnMapper, ColumnMetadata, DataFrame utilities
1514

1615
### [Schema](schema.md)
1716
HED schema management and validation:
1817

19-
- **HedSchema**: Main schema class for loading and querying schemas
20-
- **HedSchemaIO**: Schema input/output operations
21-
- **SchemaComparer**: Compare different schema versions
18+
- **Core Schema**: HedSchema, HedSchemaEntry, HedSchemaGroup, HedSchemaSection
19+
- **Schema I/O**: Schema loading, caching, and file operations
20+
- **Schema Utilities**: Comparison tools, validation utilities, compliance checking
2221

2322
### [Validator](validator.md)
2423
Validation tools and error handling:
2524

26-
- **HedValidator**: Main validation engine
27-
- **ErrorReporter**: Error collection and reporting
28-
- **ValidationContext**: Validation state management
25+
- **Core Validators**: HedValidator, SidecarValidator
26+
- **Specialized Validators**: Definition validator, onset validator, spreadsheet validator
2927

3028
### [Tools](tools.md)
31-
Utility tools and scripts:
29+
Utility tools and data transformation operations:
3230

33-
- **BidsTabularSummary**: BIDS dataset analysis
34-
- **ReorderColumns**: Spreadsheet manipulation
35-
- **TagCompareUtil**: Tag comparison utilities
31+
- **Analysis Tools**: TabularSummary, annotation utilities, tag counting
32+
- **Remodeling Operations**: Comprehensive set of data transformation operations
33+
- **Remodeling Utilities**: Remodeler, backup manager, dispatcher
3634

3735
### [Errors](errors.md)
3836
Error handling and exception classes:
3937

40-
- **HedFileError**: File-related errors
41-
- **HedExceptions**: General HED exceptions
42-
- **ErrorMessages**: Error message definitions
38+
- **Exception Classes**: HedFileError, HedExceptions
39+
- **Error Reporting**: ErrorHandler, ErrorReporter, validation context
40+
- **Error Messages**: Comprehensive error message definitions
4341

4442
## Quick Reference
4543

46-
### Loading and Using Schemas
44+
### Loading Schemas
4745

4846
::: hed.load_schema
4947
options:
50-
show_source: true
48+
show_source: false
49+
heading_level: 3
5150

52-
### Basic Validation
53-
54-
::: hed.HedString
51+
::: hed.load_schema_version
5552
options:
56-
show_source: true
57-
members:
58-
- __init__
59-
- validate
60-
- remove_definitions
53+
show_source: false
54+
heading_level: 3
6155

62-
### Working with BIDS Data
56+
### Working with HED Strings
6357

64-
::: hed.models.Sidecar
58+
::: hed.HedString
6559
options:
66-
show_source: true
67-
members:
68-
- __init__
69-
- validate
70-
- extract_definitions
60+
show_source: false
61+
heading_level: 3
62+
members: []

docs/api/models.md

Lines changed: 115 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,150 @@
22

33
Core data models for working with HED data structures.
44

5-
## HedString
5+
## Core Models
6+
7+
The fundamental data structures for HED annotations and tags.
8+
9+
### HedString
610

711
::: hed.models.hed_string.HedString
812
options:
9-
show_source: true
13+
show_source: false
14+
heading_level: 4
1015

11-
## HedTag
16+
### HedTag
1217

1318
::: hed.models.hed_tag.HedTag
1419
options:
15-
show_source: true
20+
show_source: false
21+
heading_level: 4
1622

17-
## HedGroup
23+
### HedGroup
1824

1925
::: hed.models.hed_group.HedGroup
2026
options:
21-
show_source: true
27+
show_source: false
28+
heading_level: 4
2229

23-
## Sidecar
30+
### DefinitionDict
2431

25-
::: hed.models.sidecar.Sidecar
32+
::: hed.models.definition_dict.DefinitionDict
33+
options:
34+
show_source: false
35+
heading_level: 4
36+
37+
### DefinitionEntry
38+
39+
::: hed.models.definition_entry.DefinitionEntry
40+
options:
41+
show_source: false
42+
heading_level: 4
43+
44+
## Input Models
45+
46+
Classes for handling different types of input data formats.
47+
48+
### BaseInput
49+
50+
::: hed.models.base_input.BaseInput
2651
options:
27-
show_source: true
52+
show_source: false
53+
heading_level: 4
2854

29-
## TabularInput
55+
### TabularInput
3056

3157
::: hed.models.tabular_input.TabularInput
3258
options:
33-
show_source: true
59+
show_source: false
60+
heading_level: 4
3461

35-
## SpreadsheetInput
62+
### SpreadsheetInput
3663

3764
::: hed.models.spreadsheet_input.SpreadsheetInput
3865
options:
39-
show_source: true
66+
show_source: false
67+
heading_level: 4
4068

41-
## BaseInput
69+
### TimeseriesInput
4270

43-
::: hed.models.base_input.BaseInput
71+
::: hed.models.timeseries_input.TimeseriesInput
4472
options:
45-
show_source: true
73+
show_source: false
74+
heading_level: 4
4675

47-
## ColumnMapper
76+
### Sidecar
77+
78+
::: hed.models.sidecar.Sidecar
79+
options:
80+
show_source: false
81+
heading_level: 4
82+
83+
## Query Models
84+
85+
Classes for searching and querying HED data.
86+
87+
### QueryHandler
88+
89+
::: hed.models.query_handler.QueryHandler
90+
options:
91+
show_source: false
92+
heading_level: 4
93+
94+
### Query Service Functions
95+
96+
::: hed.models.query_service.get_query_handlers
97+
options:
98+
show_source: false
99+
heading_level: 4
100+
101+
::: hed.models.query_service.search_hed_objs
102+
options:
103+
show_source: false
104+
heading_level: 4
105+
106+
## Utility Models
107+
108+
Support classes for data management and processing.
109+
110+
### ColumnMapper
48111

49112
::: hed.models.column_mapper.ColumnMapper
50113
options:
51-
show_source: true
114+
show_source: false
115+
heading_level: 4
52116

53-
## DefinitionDict
117+
### ColumnMetadata
54118

55-
::: hed.models.definition_dict.DefinitionDict
119+
::: hed.models.column_metadata.ColumnMetadata
120+
options:
121+
show_source: false
122+
heading_level: 4
123+
124+
### ColumnType
125+
126+
::: hed.models.column_metadata.ColumnType
127+
options:
128+
show_source: false
129+
heading_level: 4
130+
131+
### DataFrame Utilities
132+
133+
::: hed.models.df_util.convert_to_form
134+
options:
135+
show_source: false
136+
heading_level: 4
137+
138+
::: hed.models.df_util.shrink_defs
139+
options:
140+
show_source: false
141+
heading_level: 4
142+
143+
::: hed.models.df_util.expand_defs
144+
options:
145+
show_source: false
146+
heading_level: 4
147+
148+
::: hed.models.df_util.process_def_expands
56149
options:
57-
show_source: true
150+
show_source: false
151+
heading_level: 4

0 commit comments

Comments
 (0)