Skip to content

Commit 39ecbf2

Browse files
BEP032: Relax many levels to optional (#2363)
* relax many status to optional * Update src/schema/rules/tabular_data/microephys.yaml Co-authored-by: Reema Gupta <59512969+ree-gupta@users.noreply.github.com> --------- Co-authored-by: Reema Gupta <59512969+ree-gupta@users.noreply.github.com>
1 parent 7537d11 commit 39ecbf2

2 files changed

Lines changed: 24 additions & 24 deletions

File tree

src/schema/rules/sidecars/microephys.yaml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ microephysInstitutionInformation:
1313
- intersects([suffix], ["ecephys", "icephys"])
1414
fields:
1515
InstitutionName: recommended
16-
InstitutionAddress: recommended
17-
InstitutionalDepartmentName: recommended
16+
InstitutionAddress: optional
17+
InstitutionalDepartmentName: optional
1818

1919
microephysSetup:
2020
selectors:
@@ -25,26 +25,26 @@ microephysSetup:
2525
Manufacturer:
2626
level: recommended
2727
description_addendum: For example, `"TDT"`, `"Blackrock"`.
28-
ManufacturersModelName: recommended
29-
ManufacturersModelVersion: recommended
30-
RecordingSetupName: recommended
28+
ManufacturersModelName: optional
29+
ManufacturersModelVersion: optional
30+
RecordingSetupName: optional
3131
SamplingFrequency:
3232
level: required
3333
description_addendum: |
3434
Internal (maximum) sampling frequency (in Hz)
3535
of the recording (for example, "24000").
3636
DeviceSerialNumber:
37-
level: recommended
37+
level: optional
3838
description_addendum: |
3939
The serial number of the components of the setup,
4040
recommended to add serial numbers and versions of
4141
ALL components constituting the setup.
4242
SoftwareName:
43-
level: recommended
43+
level: optional
4444
description_addendum: |
4545
The name of the software suite used to
4646
record the data.
47-
SoftwareVersions: recommended
47+
SoftwareVersions: optional
4848
RecordingDuration: recommended
4949
RecordingType: recommended
5050
EpochLength:
@@ -64,11 +64,11 @@ microephysPharmaceuticals:
6464
- intersects([datatype], ["ecephys", "icephys"])
6565
- intersects([suffix], ["ecephys", "icephys"])
6666
fields:
67-
PharmaceuticalName: recommended
68-
PharmaceuticalDoseAmount: recommended
69-
PharmaceuticalDoseUnits: recommended
70-
PharmaceuticalDoseRegimen: recommended
71-
PharmaceuticalDoseTime: recommended
67+
PharmaceuticalName: optional
68+
PharmaceuticalDoseAmount: optional
69+
PharmaceuticalDoseUnits: optional
70+
PharmaceuticalDoseRegimen: optional
71+
PharmaceuticalDoseTime: optional
7272

7373
microephysSupplementary:
7474
selectors:
@@ -85,7 +85,7 @@ microephysSample:
8585
BodyPart: recommended
8686
BodyPartDetails: recommended
8787
BodyPartDetailsOntology: optional
88-
SampleEnvironment: recommended
88+
SampleEnvironment: optional
8989
SampleEmbedding: optional
9090
SliceThickness: optional
9191
SampleExtractionProtocol: optional
@@ -96,15 +96,15 @@ microephysTaskInformation:
9696
- intersects([suffix], ["ecephys", "icephys"])
9797
fields:
9898
TaskName:
99-
level: recommended
99+
level: optional
100100
description_addendum: |
101101
A recommended convention is to name resting state task using labels
102102
beginning with `rest`.
103-
TaskDescription: recommended
103+
TaskDescription: optional
104104
Instructions:
105-
level: recommended
105+
level: optional
106106
description_addendum: |
107107
This is especially important in context of resting state recordings and
108108
distinguishing between eyes open and eyes closed paradigms.
109-
CogAtlasID: recommended
110-
CogPOID: recommended
109+
CogAtlasID: optional
110+
CogPOID: optional

src/schema/rules/tabular_data/microephys.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ microephysProbes:
2121
AP_angle: recommended
2222
ML_angle: recommended
2323
manufacturer__probes: recommended
24-
model__probes: recommended
25-
device_serial_number: recommended
24+
model__probes: optional
25+
device_serial_number: optional
2626
electrode_count: optional
2727
width__probes: optional
2828
height__probes: optional
@@ -88,7 +88,7 @@ microephysElectrodes:
8888
For 2D electrode localizations (for example, when the coordinate system is
8989
`Pixels`), this SHOULD be a column of `n/a` values.
9090
hemisphere: recommended
91-
impedance: recommended
91+
impedance: optional
9292
shank_id: optional
9393
size__microephys: optional
9494
electrode_shape: optional
@@ -121,7 +121,7 @@ microephysChannels:
121121
For channels not associated with an electrode, use `n/a`.
122122
type__channels: required
123123
units: required
124-
sampling_frequency: optional
124+
sampling_frequency: required
125125
low_cutoff: optional
126126
high_cutoff: optional
127127
reference__microephys: optional
@@ -136,6 +136,6 @@ microephysChannels:
136136
time_offset: optional
137137
time_reference_channel: optional
138138
ground: optional
139-
recording_mode: recommended
139+
recording_mode: optional
140140
index_columns: [name__channels]
141141
additional_columns: allowed_if_defined

0 commit comments

Comments
 (0)