edf2csv 0.9.9 → 0.9.10

package/dist/convert/run.d.ts

@@ -105,7 +105,7 @@ export declare function describeFsError(cause: unknown): string;
 export declare function durationDiagnostics(annotations: readonly Annotation[], window: {
     from: number;
     to: number;
-}): Diagnostic[];
+}, gzip?: boolean): Diagnostic[];
 /**
  * What the descriptions in the events that will actually be written look like.
  *
@@ -136,7 +136,9 @@ export declare function durationDiagnostics(annotations: readonly Annotation[],
 export declare function descriptionDiagnostics(annotations: readonly Annotation[], window: {
     from: number;
     to: number;
-}): Diagnostic[];
+}, 
+/** The name the run writes the event list under; see `durationDiagnostics`. */
+gzip?: boolean): Diagnostic[];
 /**
  * The window annotations are filtered by — the bounds as asked for, not as snapped to records.
  *

package/dist/convert/run.js

@@ -157,8 +157,8 @@ export async function convert(inputPath, options = {}) {
             const window = requestedAnnotationWindow(options, plan.range.recordingStartSeconds);
             // Reported against the rows that will be written, not against the file; see
             // durationDiagnostics.
-            plan.diagnostics.push(...durationDiagnostics(annotationData.annotations, window));
-            plan.diagnostics.push(...descriptionDiagnostics(annotationData.annotations, window));
+            plan.diagnostics.push(...durationDiagnostics(annotationData.annotations, window, plan.gzip));
+            plan.diagnostics.push(...descriptionDiagnostics(annotationData.annotations, window, plan.gzip));
             const result = await writeAnnotationsCsv(outputDir, annotationData.annotations, window, options.gzip === true, options.bom === true);
             written.push(result);
             annotationsWritten = result.rows;
@@ -1176,8 +1176,19 @@ async function writeChannelsCsv(outputDir, file, plan, gzip, bom) {
  * because `duration: null` cannot say whether the file gave one; a negative duration needs no
  * flag, since the value is right there.
  */
-export function durationDiagnostics(annotations, window) {
+export function durationDiagnostics(annotations, window, 
+/*
+  And the name the run writes that file under, which these sentences did not have.
+
+  Both hints send the reader to `annotations.csv` to look at the rows they are about, and a
+  `--gzip` run writes `annotations.csv.gz`. `emptyAnnotations` two functions down takes this
+  for the same reason and has since 0.8.48 — "`--info` named `annotations.csv` for a run that
+  wrote `annotations.csv.gz`" — and the four beside it were left naming a file that is not in
+  the directory.
+*/
+gzip = false) {
     const written = annotations.filter((a) => a.onset >= window.from && a.onset < window.to);
+    const eventsFile = outputCsvName('annotations', gzip);
     const diagnostics = [];
     const negative = written.filter((a) => a.duration !== null && a.duration < 0).length;
     if (negative > 0) {
@@ -1187,7 +1198,7 @@ export function durationDiagnostics(annotations, window) {
             severity: 'warning',
             message: `${counted(negative, 'annotation')} state${one ? 's' : ''} a duration below zero, ` +
                 `which is not a length of time.`,
-            hint: 'The value is written to annotations.csv as the file gave it. Adding it to onset_s ' +
+            hint: `The value is written to ${eventsFile} as the file gave it. Adding it to onset_s ` +
                 'ends the event before it starts, so check these rows before using the durations.',
         });
     }
@@ -1232,8 +1243,11 @@ export function durationDiagnostics(annotations, window) {
  * reach `annotations.csv`, after the same window filter the writer applies, for the reason
  * `durationDiagnostics` beside it gives.
  */
-export function descriptionDiagnostics(annotations, window) {
+export function descriptionDiagnostics(annotations, window, 
+/** The name the run writes the event list under; see `durationDiagnostics`. */
+gzip = false) {
     const written = annotations.filter((a) => a.onset >= window.from && a.onset < window.to);
+    const eventsFile = outputCsvName('annotations', gzip);
     const diagnostics = [];
     const formulaic = written.filter((a) => startsFormula(a.text));
     if (formulaic.length > 0) {
@@ -1245,7 +1259,7 @@ export function descriptionDiagnostics(annotations, window) {
             message: `${counted(formulaic.length, 'annotation')} ${one ? 'has a description' : 'have descriptions'} ` +
                 `starting with ${shown}, which Excel, LibreOffice and Google Sheets read as the start ` +
                 `of a formula rather than as text.`,
-            hint: 'The text is written to annotations.csv exactly as the file has it, so the cell is ' +
+            hint: `The text is written to ${eventsFile} exactly as the file has it, so the cell is ` +
                 'what the recording says. Open the CSV with pandas or R, or import it into the ' +
                 'spreadsheet as text, if you do not want it evaluated.',
         });
@@ -1261,7 +1275,7 @@ export function descriptionDiagnostics(annotations, window) {
             severity: 'warning',
             message: `${counted(marked.length, 'annotation')} ${one ? 'has a description' : 'have descriptions'} ` +
                 `carrying text a terminal does not print as itself (${shown}), written to ` +
-                `annotations.csv exactly as the file has ${one ? 'it' : 'them'}.`,
+                `${eventsFile} exactly as the file has ${one ? 'it' : 'them'}.`,
             hint: 'A control byte can drive the terminal and a bidirectional override reverses what ' +
                 'follows it, so read the file with pandas or R rather than with cat. The cell is ' +
                 'what the recording says either way.',