Generate all stories again given new descriptions

NeurodataWithoutBorders · Jun 4, 2024 · 60602c4 · 60602c4
1 parent 1057450
commit 60602c4
Show file tree

Hide file tree

Showing 46 changed files with 504 additions and 518 deletions.
diff --git a/stories/inputs/interface_schemas/AlphaOmegaRecordingInterface.json b/stories/inputs/interface_schemas/AlphaOmegaRecordingInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "folder_path": {
                     "format": "directory",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to the folder of .mpx files."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -30,4 +31,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/AudioInterface.json b/stories/inputs/interface_schemas/AudioInterface.json
@@ -25,4 +25,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/AxonaRecordingInterface.json b/stories/inputs/interface_schemas/AxonaRecordingInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to .bin file."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -30,4 +31,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/BiocamRecordingInterface.json b/stories/inputs/interface_schemas/BiocamRecordingInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to the .bwr file."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -30,4 +31,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/BlackrockRecordingInterface.json b/stories/inputs/interface_schemas/BlackrockRecordingInterface.json
@@ -8,7 +8,7 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "description": "Path to Blackrock file.",
+                    "description": "Path to the Blackrock file with suffix being .ns1, .ns2, .ns3, .ns4m .ns4, or .ns6.",
                     "type": "string"
                 },
                 "nsx_override": {
@@ -35,4 +35,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/BlackrockSortingInterface.json b/stories/inputs/interface_schemas/BlackrockSortingInterface.json
@@ -8,7 +8,7 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "description": "Path to Blackrock file.",
+                    "description": "Path to Blackrock .nev file.",
                     "type": "string"
                 },
                 "sampling_frequency": {
@@ -32,4 +32,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/BrukerTiffMultiPlaneConverter.json b/stories/inputs/interface_schemas/BrukerTiffMultiPlaneConverter.json
@@ -8,7 +8,8 @@
             "properties": {
                 "folder_path": {
                     "format": "directory",
-                    "type": "string"
+                    "type": "string",
+                    "description": "The folder that contains the Bruker TIF image files (.ome.tif) and configuration files (.xml, .env)."
                 },
                 "plane_separation_type": {
                     "enum": [
@@ -32,4 +33,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/BrukerTiffMultiPlaneImagingInterface.json b/stories/inputs/interface_schemas/BrukerTiffMultiPlaneImagingInterface.json
@@ -9,7 +9,7 @@
                 "folder_path": {
                     "format": "directory",
                     "type": "string",
-                    "description": "The path that points to the folder containing the Bruker volumetric TIF image files and configuration files."
+                    "description": "The folder that contains the Bruker TIF image files (.ome.tif) and configuration files (.xml, .env)."
                 },
                 "stream_name": {
                     "type": "string"
@@ -30,4 +30,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/BrukerTiffSinglePlaneConverter.json b/stories/inputs/interface_schemas/BrukerTiffSinglePlaneConverter.json
@@ -26,4 +26,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/BrukerTiffSinglePlaneImagingInterface.json b/stories/inputs/interface_schemas/BrukerTiffSinglePlaneImagingInterface.json
@@ -9,7 +9,7 @@
                 "folder_path": {
                     "format": "directory",
                     "type": "string",
-                    "description": "The path that points to the folder containing the Bruker TIF image files and configuration files."
+                    "description": "The folder containing the Bruker TIF image files and configuration files."
                 },
                 "stream_name": {
                     "type": "string"
@@ -30,4 +30,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/CaimanSegmentationInterface.json b/stories/inputs/interface_schemas/CaimanSegmentationInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to .hdf5 file."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -26,4 +27,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/CellExplorerRecordingInterface.json b/stories/inputs/interface_schemas/CellExplorerRecordingInterface.json
@@ -8,7 +8,7 @@
             "properties": {
                 "folder_path": {
                     "format": "directory",
-                    "description": "The folder where the session data is located. It should contain a\n`{folder.name}.session.mat` file and the binary files `{folder.name}.dat`\nor `{folder.name}.lfp` for the LFP interface.",
+                    "description": "Folder containing the .session.mat file",
                     "type": "string"
                 },
                 "verbose": {
@@ -32,4 +32,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/CellExplorerSortingInterface.json b/stories/inputs/interface_schemas/CellExplorerSortingInterface.json
@@ -26,4 +26,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/CnmfeSegmentationInterface.json b/stories/inputs/interface_schemas/CnmfeSegmentationInterface.json
@@ -26,4 +26,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/DeepLabCutInterface.json b/stories/inputs/interface_schemas/DeepLabCutInterface.json
@@ -9,11 +9,13 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to the .h5 file output by dlc."
                 },
                 "config_file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to .yml config file"
                 },
                 "subject_name": {
                     "type": "string",
@@ -35,4 +37,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/EDFRecordingInterface.json b/stories/inputs/interface_schemas/EDFRecordingInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to the .edf file."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -30,4 +31,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/ExtractSegmentationInterface.json b/stories/inputs/interface_schemas/ExtractSegmentationInterface.json
@@ -33,4 +33,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/FicTracDataInterface.json b/stories/inputs/interface_schemas/FicTracDataInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to the .dat file (the output of fictrac)"
                 },
                 "radius": {
                     "type": "number"
@@ -33,4 +34,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/IntanRecordingInterface.json b/stories/inputs/interface_schemas/IntanRecordingInterface.json
@@ -8,11 +8,11 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to either a .rhd or a .rhs file"
                 },
                 "stream_id": {
-                    "type": "string",
-                    "default": "0"
+                    "type": "string"
                 },
                 "verbose": {
                     "type": "boolean",
@@ -34,4 +34,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/KiloSortSortingInterface.json b/stories/inputs/interface_schemas/KiloSortSortingInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "folder_path": {
                     "format": "directory",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to the output Phy folder (containing the params.py)"
                 },
                 "keep_good_only": {
                     "type": "boolean",
@@ -30,4 +31,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/MCSRawRecordingInterface.json b/stories/inputs/interface_schemas/MCSRawRecordingInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to the .raw file."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -30,4 +31,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/MEArecRecordingInterface.json b/stories/inputs/interface_schemas/MEArecRecordingInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "file_path": {
                     "format": "file",
-                    "type": "string"
+                    "type": "string",
+                    "description": "Path to the MEArec .h5 file."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -30,4 +31,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/MicroManagerTiffImagingInterface.json b/stories/inputs/interface_schemas/MicroManagerTiffImagingInterface.json
@@ -9,7 +9,7 @@
                 "folder_path": {
                     "format": "directory",
                     "type": "string",
-                    "description": "The path that points to the folder containing the OME-TIF image files."
+                    "description": "The folder containing the OME-TIF image files."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -27,4 +27,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/MiniscopeBehaviorInterface.json b/stories/inputs/interface_schemas/MiniscopeBehaviorInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "folder_path": {
                     "format": "directory",
-                    "type": "string"
+                    "type": "string",
+                    "description": "The main Miniscope folder. The movie files are expected to be in sub folders within the main folder."
                 }
             },
             "type": "object",
@@ -22,4 +23,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/MiniscopeConverter.json b/stories/inputs/interface_schemas/MiniscopeConverter.json
@@ -8,7 +8,8 @@
             "properties": {
                 "folder_path": {
                     "format": "directory",
-                    "type": "string"
+                    "type": "string",
+                    "description": "The path to the main Miniscope folder."
                 },
                 "verbose": {
                     "type": "boolean",
@@ -26,4 +27,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}
diff --git a/stories/inputs/interface_schemas/MiniscopeImagingInterface.json b/stories/inputs/interface_schemas/MiniscopeImagingInterface.json
@@ -8,7 +8,8 @@
             "properties": {
                 "folder_path": {
                     "format": "directory",
-                    "type": "string"
+                    "type": "string",
+                    "description": "The main Miniscope folder. The microscope movie files are expected to be in sub folders within the main folder."
                 }
             },
             "type": "object",
@@ -22,4 +23,4 @@
     "title": "Source data schema",
     "description": "Schema for the source data, files and directories",
     "version": "0.1.0"
-}
+}