-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
more narrative docs on converting EDF to Onda (#78)
* re-arranging * WIP convert * WIP * multi-EDF * Apply suggestions from code review Co-authored-by: Kim Laberinto <[email protected]> * clarifications from code review * ambiguous/masking * move more readme content, cleanup, * bump patch version so stable docs will be built --------- Co-authored-by: Kim Laberinto <[email protected]>
- Loading branch information
1 parent
9e899b4
commit 13da34d
Showing
6 changed files
with
369 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# API Documentation | ||
|
||
```@meta | ||
CurrentModule = OndaEDF | ||
``` | ||
|
||
## Import EDF to Onda | ||
|
||
OndaEDF.jl prefers "self-service" import over "automagic", and provides | ||
functionality to extract | ||
[`Onda.Samples`](https://beacon-biosignals.github.io/Onda.jl/stable/#Samples-1) | ||
and [`EDFAnnotationV1`](@ref)s (which extend | ||
[`Onda.AnnotationV1`](https://beacon-biosignals.github.io/Onda.jl/stable/#Onda.AnnotationV1)s) | ||
from an `EDF.File`. These can be written to disk (with | ||
[`Onda.store`](https://beacon-biosignals.github.io/Onda.jl/stable/#Onda.store) / | ||
[`Legolas.write`](https://beacon-biosignals.github.io/Legolas.jl/stable/#Legolas.write) | ||
or manipulated in memory as desired. | ||
|
||
### Import signal data as `Samples` | ||
|
||
```@docs | ||
edf_to_onda_samples | ||
plan_edf_to_onda_samples | ||
plan_edf_to_onda_samples_groups | ||
``` | ||
|
||
### Import annotations | ||
|
||
```@docs | ||
edf_to_onda_annotations | ||
EDFAnnotationV1 | ||
``` | ||
|
||
### Import plan table schemas | ||
|
||
```@docs | ||
PlanV2 | ||
FilePlanV2 | ||
write_plan | ||
``` | ||
|
||
### Full-service import | ||
|
||
For a more "full-service" experience, OndaEDF.jl also provides functionality to | ||
extract `Onda.Samples` and `EDFAnnotationV1`s and then write them to disk: | ||
|
||
```@docs | ||
store_edf_as_onda | ||
``` | ||
|
||
### Internal import utilities | ||
|
||
```@docs | ||
OndaEDF.match_edf_label | ||
OndaEDF.merge_samples_info | ||
OndaEDF.onda_samples_from_edf_signals | ||
OndaEDF.promote_encodings | ||
``` | ||
|
||
## Export EDF from Onda | ||
|
||
```@docs | ||
onda_to_edf | ||
``` | ||
|
||
## Deprecations | ||
|
||
To support deserializing plan tables generated with old versions of OndaEDF + | ||
Onda, the following schemas are provided. These are deprecated and will be | ||
removed in a future release. | ||
|
||
```@docs | ||
PlanV1 | ||
FilePlanV1 | ||
``` |
Oops, something went wrong.
13da34d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JuliaRegistrator register
13da34d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Registration pull request created: JuliaRegistries/General/87451
After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.
This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via: