This README.txt file was generated on 20230621 by Daniel Pollak


-------------------
GENERAL INFORMATION
-------------------


1. Title of Dataset: 
Parsing social context in auditory forebrain of male zebra finches with a versatile microdrive. 




#
# Authors: Include contact information for at least the 
# first author and corresponding author (if not the same), 
# specifically email address, phone number, and institution. 
# Contact information for all authors is preferred.
#

2. Author Information

  First Author Contact Information
        Name: Daniel Pollak
           Institution: California Institute of Technology
           Address: 1200 E California Blvd
           Email: dpollak@caltech.edu


  Corresponding Author Contact Information
        Name: Luke Remage-Healey
           Institution: University of Massachusetts, Amherst
           Address: 
           Email: 


  Author Contact Information
           Name: Daniel M. Vahaba
           Institution: Duke University
           Address: Duke University Institute for Brain Sciences, Durham, NC 27708, United States
           Email: daniel.vahaba@duke.edu


  Author Contact Information
           Name: Matheus Macedo-Lima
           Institution:  University
           Address: University of Maryland, College Park, College Park, MD 20742, United States
           Email: mmacedol@umd.edu



---------------------
DATA & FILE OVERVIEW
---------------------

#
# Directory of Files in Dataset: List and define the different 
# files included in the dataset. This serves as its table of 
# contents. 
#

Directory of Files
   A. Filename: database.pkl     
      Short description: A dataframe comprising LFP data across subjects, stimuli, and dates from before, during, and after the stimulus     
        
   B. Filename: soc_context_df.pkl     
      Short description: A dataframe comprising LFP data from two subjects across social contexts and stimuli from before, during and after the stimulus
        
   C. Filename: Fig1Stats.csv    
      Short description: A dataframe comprising data visualized in Figure 2 (the name does not reflect the figure), including BL FR, FR, Z, and offset ratio (here called PIRrat).

   D. Filename: Fig3All_lofilt.csv
      Short description: A dataframe comprising data visualized in Figure 3. the lofilt suffix indicates that it originates from a dataset of single units which were filtered for inclusion on the basis of waveform shape using an only moderately conservative approach rather than a highly conservative approach. The format of these data is similar to that in Fig1Stats.csv.

   E. Filename: Fig3BOSTlofilt.csv
      Short description: A dataframe comprising data visualized in Figure 3, with stimulus-specific responses subtracted with respect to BOS. The format of these data is similar to that in Fig1Stats.csv.

   F. Filename: selectivityIndex.csv     
      Short description: 

   G. Filename: t1MapsFR.csv  
      Short description: A dataframe comprising data visualized in Figure 3. These data reflect d' values for individual neurons across each stimulus pair for the solitary audition condition for experiment 2.

   H. Filename: t2MapsFR.csv    
      Short description: A dataframe comprising data visualized in Figure 3. These data reflect d' values for individual neurons across each stimulus pair for the social audition condition for experiment 2.

   I. Filename: DJPComb_*.zip
      Short description: Compressed folder containing raw multichannel electrophysiology data (16 or 32 channel, int16). Also contains assorted files generated during sorting with Kilosort.





#
# File Naming Convention: Define your File Naming Convention 
# (FNC), the framework used for naming your files systematically 
# to describe what they contain, which could be combined with the
# Directory of Files. 
#

File Naming Convention (if not included above):
DJPComb_<subject ID> <MM DD YY> <recording name>_<YYMMDD_hhmmss>_Kilosort


--------------------------
METHODOLOGICAL INFORMATION
--------------------------

#
# Software: If specialized software(s) generated your data or
# are necessary to interpret it, please provide for each (if
# applicable): software name, version, system requirements,
# and developer.
#

1. Software-specific information:
<create a new entry for each qualifying software program>

Name: MATLAB
Version: R2020b
System Requirements:
https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2020b-windows.pdf

Developer: MathWorks
Product URL: https://www.mathworks.com/products/matlab.html

Name: Miniconda
Version: 
System Requirements:
https://docs.conda.io/en/latest/miniconda.html#system-requirements

Developer: Anaconda Enterprise
Product URL: https://docs.conda.io/en/latest/miniconda.html











#
# Equipment: If specialized equipment generated your data,
# please provide for each (if applicable): equipment name,
# manufacturer, model, and calibration information. Be sure
# to include specialized file format information in the data
# dictionary.
#

2. Equipment-specific information:
<create a new entry for each qualifying piece of equipment>

Manufacturer: Intan
Model: RHD2000

Manufacturer: Intan
Model: RHD USB interface board

Manufacturer: Intan
Model: RHD 32-channel headstage

Manufacturer: Intan
Model: RHD 16-channel headstage

Additional Notes:
Intan RHD 2000 is no longer in production but a suitable alternative is the Open Ephys Acquisition Board.



#
# Dates of Data Collection: List the dates and/or times of
# data collection.
#

3. Date of data collection:
20181101
20181102
20181103
20181104
20181108
20181109
20181117
20181117
20190815
20190914
20191012
20191013
20191013
20191017
20200221