Skip to content

Commit

Permalink
Minor type corrections started MATLAB section rewrite
Browse files Browse the repository at this point in the history
  • Loading branch information
VisLab committed May 30, 2024
1 parent a32e00e commit dc261a7
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 28 deletions.
4 changes: 2 additions & 2 deletions docs/source/HedMatlabTools.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(hed-matlab-tools-anchor)=
# HED MATLAB tools
(matlab-hedtools-anchor)=
# MATLAB HedTools

The goal of the HED MATLAB tools is to provide access to HED tools from MATLAB without knowledge of Python.
The HED tools allow validation, summary, search, factorization, data epoching
Expand Down
42 changes: 21 additions & 21 deletions docs/source/HedSchemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,27 +82,27 @@ The HED standard schema source is located in the
[**standard_schema**](https://github.com/hed-standard/hed-schemas/tree/main/standard_schema)
directory of the [**hed-schemas**](https://github.com/hed-standard/hed-schemas) GitHub repository.

| Format | Type | Use |
| ------ | ---- | ---- |
| XML | [**Raw**](https://raw.githubusercontent.com/hed-standard/hed-schemas/main/standard_schema/hedxml/HED8.2.0.xml) | Accessed by tools for validation and analysis. |
| | [**Formatted**](https://github.com/hed-standard/hed-schemas/blob/main/standard_schema/hedxml/HED8.2.0.xml) | Readable display. |
| Mediawiki | [**Raw**](https://raw.githubusercontent.com/hed-standard/hed-schemas/main/standard_schema/hedwiki/HED8.1.0.mediawiki) | Edited to create a new schema. |
| | [**Formatted**](https://github.com/hed-standard/hed-schemas/blob/main/standard_schema/hedwiki/HED8.1.0.mediawiki) | Readable display for editing. |
| Prerelease | [**Directory**](https://github.com/hed-standard/hed-schemas/tree/main/library_schemas/score/prerelease) | Working directory for developing the prerelease. |
| Format | Type | Use |
|------------| ---- | ---- |
| XML | [**Raw**](https://raw.githubusercontent.com/hed-standard/hed-schemas/main/standard_schema/hedxml/HED8.2.0.xml) | Accessed by tools for validation and analysis. |
| | [**Formatted**](https://github.com/hed-standard/hed-schemas/blob/main/standard_schema/hedxml/HED8.2.0.xml) | Readable display. |
| MediaWiki | [**Raw**](https://raw.githubusercontent.com/hed-standard/hed-schemas/main/standard_schema/hedwiki/HED8.1.0.mediawiki) | Edited to create a new schema. |
| | [**Formatted**](https://github.com/hed-standard/hed-schemas/blob/main/standard_schema/hedwiki/HED8.1.0.mediawiki) | Readable display for editing. |
| Prerelease | [**Directory**](https://github.com/hed-standard/hed-schemas/tree/main/library_schemas/score/prerelease) | Working directory for developing the prerelease. |

### The SCORE library

The HED SCORE library is an implementation of the [**SCORE**](https://hed-schemas.readthedocs.io/en/latest/hed_lisa_schema.html) standard for clinical annotation of EEG by neurologists.
For more information and the latest references see
[**HED SCORE schema**](https://hed-schemas.readthedocs.io/en/latest/hed_score_schema.html).

| Format | Type | Use |
| ------ | ---- | ---- |
| XML | [**Raw**](https://raw.githubusercontent.com/hed-standard/hed-schemas/main/library_schemas/score/hedxml/HED_score_1.0.0.xml) | Accessed by tools for validation and analysis. |
| | [**Formatted**](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedxml/HED_score_1.0.0.xml) | Readable display. |
| Mediawiki | [**Raw**](https://raw.githubusercontent.com/hed-standard/hed-schemas/main/library_schemas/score/hedwiki/HED_score_1.0.0.mediawiki) | Edited to create a new schema. |
| | [**Formatted**](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedwiki/HED_score_1.0.0.mediawiki) | Readable display for editing. |
| Prerelease | [**Directory**](https://github.com/hed-standard/hed-schemas/tree/main/library_schemas/score/prerelease) | Working directory for developing the prerelease. |
| Format | Type | Use |
|------------| ---- | ---- |
| XML | [**Raw**](https://raw.githubusercontent.com/hed-standard/hed-schemas/main/library_schemas/score/hedxml/HED_score_1.0.0.xml) | Accessed by tools for validation and analysis. |
| | [**Formatted**](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedxml/HED_score_1.0.0.xml) | Readable display. |
| MediaWiki | [**Raw**](https://raw.githubusercontent.com/hed-standard/hed-schemas/main/library_schemas/score/hedwiki/HED_score_1.0.0.mediawiki) | Edited to create a new schema. |
| | [**Formatted**](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedwiki/HED_score_1.0.0.mediawiki) | Readable display for editing. |
| Prerelease | [**Directory**](https://github.com/hed-standard/hed-schemas/tree/main/library_schemas/score/prerelease) | Working directory for developing the prerelease. |

### The LISA library

Expand All @@ -112,11 +112,11 @@ For more information and the latest references see
[**HED LISA schema**](https://hed-schemas.readthedocs.io/en/latest/hed_lisa_schema.html).
The LISA library is under development and is only available in prerelease format.

| Format | Type | Use |
| ------ | ---- | ---- |
| XML | **Raw** | Accessed by tools for validation and analysis. |
| | [**Formatted**] | Readable display. |
| Mediawiki | [**Raw**] | Edited to create a new schema. |
| | [**Formatted**] | Readable display for editing. |
| Prerelease | [**Directory**](https://github.com/hed-standard/hed-schemas/tree/main/library_schemas/lisa/prerelease) | Working directory for developing the prerelease. |
| Format | Type | Use |
|------------| ---- | ---- |
| XML | **Raw** | Accessed by tools for validation and analysis. |
| | [**Formatted**] | Readable display. |
| MediaWiki | [**Raw**] | Edited to create a new schema. |
| | [**Formatted**] | Readable display for editing. |
| Prerelease | [**Directory**](https://github.com/hed-standard/hed-schemas/tree/main/library_schemas/lisa/prerelease) | Working directory for developing the prerelease. |

2 changes: 1 addition & 1 deletion docs/source/HedValidationGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ HED validation in MATLAB is currently done by accessing the HED online tools as
#### Direct access to services
Users can access these services directly by calling wrapper functions or by using the HED MATLAB web services
functions as explained in
[**HED MATLAB tools**](./HedMatlabTools.md#hed-matlab-tools-anchor).
[**MATLAB HedTools**](./HedMatlabTools.md).
Download the [**web_services**](https://github.com/hed-standard/hed-matlab/tree/main/hedmat/web_services)
directory from GitHub and include this directory in your MATLAB path.
The [**runAllDemos.m**](https://raw.githubusercontent.com/hed-standard/hed-matlab/main/hedmat/web_services/runAllDemos.m)
Expand Down
5 changes: 1 addition & 4 deletions docs/source/HowCanYouUseHed.md
Original file line number Diff line number Diff line change
Expand Up @@ -616,17 +616,14 @@ for more information on installation and use.
The project source code is located in the [**CTagger**](https://github.com/hed-standard/ctagger) GitHub repository.
<p></p>

[**HED MATLAB tools**](https://www.hed-resources.org/en/latest/HedMatlabTools.html#hed-matlab-tools) explains how the
[*MATLAB HedTools**](https://www.hed-resources.org/en/latest/MatlabHedTools.md) explains how the
users can use the HEDTools in MATLAB using one of three approaches: using MATLAB wrappers for the HED Python tools,
using MATLAB wrappers for the HED web services, or by calling HED tools through EEGLAB.

The [**HED online services**](https://hedtools.ucsd.edu/hed) can be called programmatically in MATLAB. The HED services are deployed online through a docker container
as described in [**Web tools and rest services**](web-tools-and-rest-services-anchor).
<p></p>

[**Python HEDTools in MATLAB**](./HedMatlabTools.md#python-hedtools-in-matlab)
explains how to install and call various Python tools from MATLAB.
<p></p>

(web-tools-and-rest-services-anchor)=
#### Web tools and REST services
Expand Down

0 comments on commit dc261a7

Please sign in to comment.