edf2csv 0.4.76 → 0.4.78

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,48 @@
3
3
  Notable changes to edf2csv. Versions follow [semantic versioning](https://semver.org); while the
4
4
  major version is 0, a minor bump may contain breaking changes.
5
5
 
6
+ ## 0.4.78
7
+
8
+ ### Fixed: `sleep-study.edf` was four different recordings across the site
9
+
10
+ The same filename appears on the landing page, in getting-started, in cli-reference and in
11
+ edf-format, and each showed `--info` output for a different file: 28800 records of EDF+ at
12
+ 100/10/1 Hz, three records of plain EDF at 256/128/1 Hz, 29550 records at 25.1 MB, and three
13
+ records carrying a real patient identifier. A reader working through the pages in order was
14
+ told the name meant something different each time.
15
+
16
+ Worse than untidy in one place: getting-started showed a three-second recording, then said
17
+ "on a long recording, `--info` tells you four things before you spend any disk", then told
18
+ the reader to run `--start 30m --duration 5m` on it — a window that file does not have.
19
+
20
+ The two channel-table blocks are regenerated from the recording 0.4.77 made reproducible, so
21
+ they are that file's real output. The identification-fields example in edf-format is a
22
+ different recording and now has a different name, `telemetry-psg.edf`, with a line saying
23
+ why: it carries the EDF+ specification's own example patient header, and `sleep-study.edf`
24
+ is anonymised, so it cannot demonstrate what that section is about.
25
+
26
+ The test from 0.4.77 now checks every page: any block that opens with `File sleep-study.edf`
27
+ must match what the tool prints for that recording.
28
+
29
+ ## 0.4.77
30
+
31
+ ### Fixed: the landing page showed an annotations.csv the recording could not produce
32
+
33
+ The page says every terminal block and CSV sample on it is real output from one synthetic
34
+ sleep recording, and the recipe for that recording lived in a comment. Which made the claim
35
+ unfalsifiable in practice: checking it meant rebuilding a 19 MB file by hand from prose. The
36
+ page drifted twice anyway — a row figure in 0.4.67, a `UTC` suffix in 0.4.68 — and this
37
+ found a third. Its `annotations.csv` sample shows `Sleep stage W` at onset 0. The recording
38
+ had an annotation channel with no events in it at all, so the real file is a header row and
39
+ nothing else.
40
+
41
+ The recipe is a module now, `test/fixtures/sleep-study.mjs`, and the recording carries the
42
+ sleep staging a sleep study carries. A test rebuilds it, runs `--info`, and compares the
43
+ output against the page character for character; then converts two seconds of it and checks
44
+ each CSV sample really is how that file starts. Samples that are abridged say so with an
45
+ ellipsis and are left alone — which the `metadata.json` sample did not, while showing
46
+ `"version": "0.1.0"`. It is now visibly an extract.
47
+
6
48
  ## 0.4.76
7
49
 
8
50
  ### Added: the API reference's examples are run, not just displayed
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edf2csv",
3
- "version": "0.4.76",
3
+ "version": "0.4.78",
4
4
  "description": "Convert EDF, EDF+ and BDF biosignal recordings (European Data Format) to CSV from the command line. Local, streaming, and never resamples or alters units.",
5
5
  "keywords": [
6
6
  "edf",