Include recording metadata in abr_deafening_results.mat, add information to README.md

ABR/READ_ME.txt

@@ -1,17 +0,0 @@
-This READ_ME explains the variables in the 'abr_analysis_results.mat' file.
-
-allCONFI
-	structure with 3 matrices
-	frequencies = tested frequencies in kHz
-	levels = tested sound levels in dB
-	confidence results from bootstrap analysis for the corresponding frequency-level combination
-
-date
-	recording dates for the ABR measurements (format JJJJMMDD)
-
-
-resultTHRES
-	The left column gives the measured frequencies and the right column the corresponding
-	sound levels, which show the first >0.95 confidence in the bootstrap analysis (only if all
-	higher sound levels also show >0.95 confidence). Each row represents one Audiogram for one
-	individual (top to bottom: deafened 1-3 and then control 1-3).

ABR/abr_data_analysis.m

@@ -135,5 +135,6 @@ end
 
 %% saving of the variables
 if saveon==1
-    save('abr_deafening_results.mat','date','resultTHRES','allCONFI');
+    bats = strcat('b', animalname);
+    save('abr_deafening_results.mat','dates','bats','resultTHRES','allCONFI');
 end

README.md

@@ -117,4 +117,31 @@ http://audition.ens.fr/adc/sw/yin.zip (de Cheveigné & Kawahara, JASA
 
 ## Auditory brainstem responses
 
-TODO
+The `abr_analysis_results.mat` file in the `ABR` directory is a MATLAB
+data file with three variables:
+
+* `dates`: Recording dates of each ABR measurement sessions, formatted
+  as YYYYMMDD strings.
+* `bats`: Identity of the animal in each ABR measurement session.  Note
+  that the first (earliest) recording for each bat was acquired before
+  any deafening.
+* `allCONFI`: A structure array, indexed on ABR measurement session
+  number and containing three matrices, namely
+  - `frequencies`, the frequencies of the stimulation tone pips in Hz,
+  - `levels`, the tested sound levels in dB, and
+  - `confidences`, a confidence value for whether the tone pip specified
+    by frequency and level evoked an auditory brainstem response, based
+    on a bootstrap analysis.
+* `resultTHRES`: A structure array, indexed on ABR measurement session
+  number and containing two matrices, namely
+  - `uniqueFrequencies`, the unique frequencies of the stimulation tone
+    pips in Hz, and
+  - `bootstrapThresholds`, the lowest sound level for the corresponding
+    frequency for which an auditory brainstem response was obtained with
+    a confidence value of 0.95 or greater, or NaN if there is no such
+    level.
+
+`abr_data_analysis.m`, provided for reference, is the MATLAB script by
+which these data were extracted from the raw ABR measurements.
+`abr_data_plot.m` was used to generate the supplementary ABR audiometry
+figure.