edf2csv 0.5.108 → 0.5.110

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 +63 -0
  2. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,69 @@
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.5.110
7
+
8
+ ### Fixed: the reference said there was one way a long file comes out unsorted, and quoted it wrong
9
+
10
+ `--layout long` writes one row per sample, sorted by `time_s` — because records are written in
11
+ file order and each record's samples fall inside its own span. The reference named "one exception
12
+ the format allows and the tool warns about". There are two, and the tool warns about both.
13
+
14
+ The first is the obvious one: a discontinuous recording may store its records in a different order
15
+ than it times them. The second is overlap. Records of one second at 0 s and 0.25 s have strictly
16
+ increasing starts, so nothing fires for order, and the column comes out `0.000, 0.500, 0.250,
17
+ 0.750` anyway, because the first record's samples run past where the second begins. That case has
18
+ had its own warning since 0.5.25 and its own entry in warnings-and-errors; the page that describes
19
+ the layout's ordering didn't mention it.
20
+
21
+ Both are now described where the guarantee is stated, with the arithmetic for the overlapping one.
22
+
23
+ ### Fixed: two quoted warnings that no version prints
24
+
25
+ 0.5.107 made these two sentences agree with the number they count. The documentation kept the
26
+ sentences from before it:
27
+
28
+ ```
29
+ warning: 2 data records start earlier than the record before it. (the reference)
30
+ warning: 1 data record start earlier than the record before it. (warnings-and-errors)
31
+ ```
32
+
33
+ One wrong pronoun and one wrong verb, and between them every count a reader might search their
34
+ logs for.
35
+
36
+ A test now generates all four of these sentences — both kinds, singular and plural — from files
37
+ built for the purpose, and holds every quoted `warning:` line in the documentation that counts
38
+ data records to the set.
39
+
40
+ ## 0.5.109
41
+
42
+ ### Fixed: three pages still described an inverted channel by the rule that was corrected
43
+
44
+ What inverts a channel is a negative gain, and the gain is
45
+ `(physical_max - physical_min) / (digital_max - digital_min)` — so reversing exactly one of the
46
+ two bounds pairs inverts the polarity, and reversing both leaves it positive and ordinary. The
47
+ code was corrected to that rule and `reversed-bounds.edf` was written to hold it: three channels,
48
+ two warned about, one not.
49
+
50
+ One page was corrected with it. Three were not:
51
+
52
+ - **correctness** listed "`physicalMin` above `physicalMax`" as a header condition that raises
53
+ `INVERTED_PHYSICAL_RANGE`.
54
+ - **edf-format** said "`physicalMin > physicalMax` inverts the polarity of the channel".
55
+ - **output-files**, describing the `physical_min` and `physical_max` columns of `channels.csv`,
56
+ called such a channel "an inverted channel" outright — the page a reader lands on when they
57
+ are looking at those two columns and wondering.
58
+
59
+ The fixture's third channel is exactly that shape and draws nothing.
60
+
61
+ All three now state the rule by the sign of the gain and say what reversing both pairs does.
62
+ `reversed-bounds.edf` is also added to correctness's fixture table, which claimed the inversion
63
+ row had a fixture "listed below" and then didn't list it.
64
+
65
+ A test opens that fixture, confirms the channel is still there and still unwarned, and then
66
+ holds every page to it. It reads the backticked field and column names, so the warning's own
67
+ sentence — true of the channel it names — is not caught by it.
68
+
6
69
  ## 0.5.108
7
70
 
8
71
  ### Fixed: the annotations page said the example recording has one signal
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edf2csv",
3
- "version": "0.5.108",
3
+ "version": "0.5.110",
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",