Browse Source

Update README and datacite.yml

Michael Schutte 2 years ago
parent
commit
dfa6a376b8
2 changed files with 40 additions and 28 deletions
  1. 37 25
      README.md
  2. 3 3
      datacite.yml

+ 37 - 25
README.md

@@ -1,9 +1,9 @@
 # p_discolor_auditory_feedback
 
 Acoustic parameters of P. discolor vocalisations, auditory brainstem
-responses, and data analysis programs for Lattenkamp et al., “Learning
-how to call: the vocal development of the pale spear-nosed bat is
-dependent on auditory feedback”.
+responses, and data analysis programs for Lattenkamp et al., “The vocal
+development of the pale spear-nosed bat is dependent on auditory
+feedback”.
 
 ## Vocalisations
 
@@ -15,15 +15,16 @@ The `vocalisations` directory provides data in four CSV files:
   were up to half a year old; in `adult_calls.csv`, the same individuals
   were 2 years old.  The juvenile recordings were acquired with pairs of
   bats: (deafened or normal-hearing) juveniles and their (always
-  normal-hearing) respective mothers, as well as with pairs of one
-  deafened and one normal-hearing juvenile.  The adult recordings were
+  normal-hearing) respective mothers.  The adult recordings were
   acquired from groups of two or three bats such that within each
   recording session, all were either deafened or of normal hearing.
 
   `pup_calls.csv` includes the vocalisations from the juvenile bats’
   respective mothers which were placed in the recording chamber with
-  their offspring in some of the sessions.  These data have not been
-  analysed further by the authors.
+  their offspring in some of the sessions, as well as vocalisations from
+  sessions in which normal-hearing juveniles were paired with deaf
+  juveniles.  Neither of these data have been analysed further by the
+  authors.
 
 * `pup_sessions.csv`, `adult_sessions.csv`: Metadata for the recording
   sessions.
@@ -44,24 +45,29 @@ one bat.  The columns are:
   the extracted vocalisation started. Can be calculated from
   `start_sample` and the metadata in `*_sessions.csv`, based on the
   sampling rate of 192 kHz.
-* `calling_bat` (`pup_calls.csv`): Identifier of the animal which
+* `calling_bat` (`pup_calls.csv` only): Identifier of the animal which
   emitted the vocalisation.  This can be determined by comparing levels
   in the microphone array in the recording chamber, as the position of
-  the bats within the chamber was known and fixed.  This column is empty
-  in `adult_calls.csv`, where the recording setup did not facilitate
-  this analysis.
-* `other_bat` (`pup_calls.csv`): Identifier of the animal which was in
-  the recording chamber with the calling bat, but did not emit the
-  vocalisation.  Empty in `adult_calls.csv`, where this information is
+  the bats within the chamber was known and fixed.  This column is
+  missing from `adult_calls.csv`, where the recording setup did not
+  facilitate this analysis.
+* `other_bat` (`pup_calls.csv` only): Identifier of the animal which was
+  in the recording chamber with the calling bat, but did not emit the
+  vocalisation.  Missing in `adult_calls.csv`, where this information is
   unknown.
-* `calling_bat_deaf`: 1 if the calling bat was deafened, 0 otherwise.
-  Note that in `pup_calls.csv`, the first session of each
-  juvenile–mother pairing was recorded before deafening, yet
-  `calling_bat_deaf` is 1 even in those sessions.
-* `before_deafening`: 1 if this vocalisation occurred in the first
-  session of a juvenile (before any deafening), 0 otherwise.
-* `calling_bat_mother`: 1 if the calling bat was a mother, 0 otherwise.
-* `level_difference` (`pup_calls.csv`; in dB): Difference between the
+* `calling_bat_deaf` (`pup_calls.csv` only): 1 if the calling bat was
+  deafened, 0 otherwise.  Note that in `pup_calls.csv`, the first
+  session of each juvenile–mother pairing was recorded before deafening,
+  yet `calling_bat_deaf` is 1 even in those sessions.
+* `group` (`adult_calls.csv` only): The string “hearing” or “deaf”,
+  reflecting the group that all individuals in the recording session
+  belonged to.
+* `before_deafening` (`pup_calls.csv` only): 1 if this vocalisation
+  occurred in the first session of a juvenile (before any deafening), 0
+  otherwise.
+* `calling_bat_mother` (`pup_calls.csv` only): 1 if the calling bat was
+  a mother, 0 otherwise.
+* `level_difference` (`pup_calls.csv` only): Difference between the
   root-mean-square vocalisation levels of the microphones closer to one
   bat vs. the microphones closer to the other bat.  Used to determine
   `calling_bat` and `other_bat` in sessions with juveniles.
@@ -90,6 +96,11 @@ is structured similarly, but replaces the two `animalX` columns with
 `group`, which is either `deaf` or `hearing`, and does not contain
 `before_deafening`.
 
+Note that the session IDs have not been assigned systematically.  In
+particular, the temporal order of the sessions cannot be determined from
+the numerical ID values.  This information must be extracted from
+`pup_sessions.csv`/`adult_sessions.csv`.
+
 ### Animals
 
 The individuals referred to in the data files were:
@@ -104,8 +115,9 @@ The individuals referred to in the data files were:
 
 ### Scripts
 
-`scripts` contains the Jupyter notebook which was used to create the
-figures and tables included in the publication.
+`scripts` contains the Python script which was used to create the
+figures and tables included in the publication, and the R script which
+was used to conduct the statistical analysis.
 
 `scripts_for_reference` is of documentary nature and contains the MATLAB
 and Python code which was used to extract the acoustic parameters and
@@ -118,7 +130,7 @@ Cheveigné & Kawahara, JASA 111:1917:1930, 2002, doi:10.1121/1.1458024).
 ### Exemplary raw data
 
 A sample of raw data files is included in this dataset.  Specifically,
-22 of the 352 recording sessions (including data from all six juvenile
+18 exemplary recording sessions (including data from all six juvenile
 bats) are provided as 2-channel, 192 kHz, 24-bit PCM audio data.  For
 more efficient storage, these have been compressed using a lossless
 codec and are provided in FLAC containers in the

+ 3 - 3
datacite.yml

@@ -31,11 +31,11 @@ authors:
     affiliation: "Department Biology II, LMU München, Martinsried, Germany"
     id: "ORCID:0000-0002-2017-3465"
 
-title: "Data for “Learning how to call: the vocal development of the pale spear-nosed bat is dependent on auditory feedback”"
+title: "Data for Lattenkamp et al., 2021, “The vocal development of the pale spear-nosed bat is dependent on auditory feedback”"
 
 description: |
-  Acoustic call parameters, auditory brainstem responses, and data analysis
-  programs for Lattenkamp et al., “Learning how to call: the vocal development
+  Acoustic call parameters, auditory brainstem responses, and data
+  analysis programs for Lattenkamp et al., 2021, “The vocal development
   of the pale spear-nosed bat is dependent on auditory feedback”.
 
 keywords: