Skip to content

Commit

Permalink
Update docs for onda_to_edf to accurately reflect input (#47)
Browse files Browse the repository at this point in the history
* update docs to reflect actual input expectations for onda_to_edf

* bump patch to update stable docs

* grammar
  • Loading branch information
kleinschmidt committed Jun 15, 2022
1 parent f81fb19 commit 31a5976
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "OndaEDF"
uuid = "e3ed2cd1-99bf-415e-bb8f-38f4b42a544e"
authors = ["Beacon Biosignals, Inc."]
version = "0.10.0"
version = "0.10.1"

[deps]
Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
Expand Down
24 changes: 13 additions & 11 deletions src/export_edf.jl
Original file line number Diff line number Diff line change
Expand Up @@ -132,22 +132,24 @@ end
#####

"""
onda_to_edf(signals, annotations=[]; kwargs...)
onda_to_edf(samples::AbstractVector{<:Samples}, annotations=[]; kwargs...)
Return an `EDF.File` containing signal data converted from the Onda [`signals`
table](https://beacon-biosignals.github.io/Onda.jl/stable/#*.onda.signals.arrow-1)
and (optionally) annotations from an [`annotations`
Return an `EDF.File` containing signal data converted from a collection of Onda
[`Samples`](https://beacon-biosignals.github.io/Onda.jl/stable/#Samples-1) and
(optionally) annotations from an [`annotations`
table](https://beacon-biosignals.github.io/Onda.jl/stable/#*.onda.annotations.arrow-1).
Following the Onda v0.5 format, both `signals` and `annotations` can be any
Tables.jl-compatible table (DataFrame, Arrow.Table, NamedTuple of vectors, vector of
NamedTuples) which follow the signal and annotation schemas (respectively).
Following the Onda v0.5 format, `annotations` can be any Tables.jl-compatible
table (DataFrame, Arrow.Table, NamedTuple of vectors, vector of NamedTuples)
which follows the [annotation
schema](https://beacon-biosignals.github.io/Onda.jl/stable/#*.onda.annotations.arrow-1).
Each `EDF.Signal` in the returned `EDF.File` corresponds to a channel of an `Onda.Signal`.
Each `EDF.Signal` in the returned `EDF.File` corresponds to a channel of an
input `Onda.Samples`.
The ordering of `EDF.Signal`s in the output will match the order of the rows of
the signals table (and within each channel grouping, the order of the signal's
channels).
The ordering of `EDF.Signal`s in the output will match the order of the input
collection of `Samples` (and within each channel grouping, the order of the
samples' channels).
"""
function onda_to_edf(samples::AbstractVector{<:Samples}, annotations=[]; kwargs...)
edf_header = onda_samples_to_edf_header(samples; kwargs...)
Expand Down

2 comments on commit 31a5976

@kleinschmidt
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

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/62415

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:

git tag -a v0.10.1 -m "<description of version>" 31a597629916edf8f333457186d760f6c30cb417
git push origin v0.10.1

Please sign in to comment.