padillacoreanolab/social_competiton_elo_rating

Behavioral Dataframe Processing

Overview

• This project helps calculate the ELO rating for different social competition assays. The data collected for these assays are Excel sheets that are used during the recording. The assays includes tube test, urine marking, home cage observation, and reward competition. ELO ratings keep track of the overall performance for a given subject, which can be compared to other subjects within the same cage to approximate the "ranking". Because the assays have multiple recordings for each subject, the ELO ratings will be calculated after each interaction.

Repository Organization

• ./jupyter_notebooks
  • Directory that has the Jupyter Notebooks to calculate the ELO ratings and create the accompanying dataframes/plots. These notebooks will be copied into ./results
• ./results
  • Directory to store individual analysis. We recommend naming the folder in this convention: {date}_{overall experiment name}_{protocol}
    • e.g. 20221220_pilot3_tubetest
• ./src
  • Directory that has the Python source code used in the Jupyter Notebooks. All the original functions used in the notebooks will be imported from this.
• ./conda_environment
  • Directory to create and store the Conda Environment to run Jupyter Notebooks and calculate ELO score.

Steps To Take

Step 0: Learn how to use the Command Line

• The Command-line interface is where we type in commands to make a computer do various tasks. This interface is presented by programs that are usually called the "terminal."
  • For more information: https://en.wikipedia.org/wiki/Command-line_interface

1. Before starting, you must pick a program for your Command-line interface.
   • For Mac, we recommend the Terminal application.
     • Instructions on how to use the Terminal: https://macpaw.com/how-to/use-terminal-on-mac
     • Video Tutorial: https://www.youtube.com/watch?v=MBBWVgE0ewk
   • For Windows, we recommend using the Command Prompt
     • Instructions on how to use the Command Prompt: https://www.cs.princeton.edu/courses/archive/spr05/cos126/cmd-prompt.html
     • Video Tutorial: https://www.youtube.com/watch?v=aKRYQsKR46I

1.1 When editing and reading code, it is helpful to use a code editor that has features specific to programing. We recommend downloading Visual Studio Code. - Download Link: https://code.visualstudio.com/Download

Step 1(GUI Version). Clone this repository

0. If using Windows or Mac, install the Github GUI from https://desktop.github.com/

1. Open the Github Desktop application, and click File >> Clone Repository

2. Click on the URL tab, and copy the link to the repository into the Repository URL prompt.

   • Link to this repository https://github.com/padillacoreanolab/social_competiton_elo_rating.git

3. Choose the path that you want to clone the Github Repository into and click Clone

   • We recommend: {user_directory}/Documents/Github

4. Go to the folder of the Github Repository, and open up the terminal to that folder.

   • If you right click in the file explorer, there will usually be an option to open the terminal from the folder. If not, then open the terminal and navigate to the folder with cd {user_directory}/Documents/Github/social_competiton_elo_rating

Step 1(Command Line Version). Clone this repository

1. Check if you have the Git program on your computer. Open up Command-line interface program. We recommend Command Prompt for Windows, and Terminal for Mac.

1.1 In the terminal, type git then enter. - Documentation of Git should be displayed if it is properly installed on your computer. If it says that command is not recognized or that the program doesn't exist, then install it with one of the following instructions: - Windows: https://garnet-rotate-01f.notion.site/Git-Installation-with-Windows-09e4f9f13c9f47c48c8d02a1f7647704 - Mac: https://garnet-rotate-01f.notion.site/Git-Installation-with-Mac-b5e51901e97b4c65a114bb25bc9f2dfa

2. Once you have Git, download the repository in a folder that you want to save it in. To move to the desired folder, type the following command into your Command-line interface program: cd {/path/to/folder}
   • Replace {/path/to/folder} with the absolute or relative path to the folder that you want to save the Github repository in. We recommend creating a folder for programming related projects.
   • More information on what an absolute or relative path is:
     • Mac: https://www.josharcher.uk/code/find-path-to-folder-on-mac/
     • Windows: https://www.computerhope.com/issues/ch001708.htm

2.1 Download the Github repository with the command: git clone https://github.com/padillacoreanolab/social_competiton_elo_rating - NOTE: Every time you use this repo after cloning it, check for updates with: - cd {./path/to}/social_competiton_elo_rating - git pull origin main

Step 2. Create Conda Environment to Install Necessary Python libraries

1. Check if you have Anaconda:

   • Type python in your terminal, and then press Enter. If you have Anaconda, then it will say "Anaconda" somewhere in the output.
   • If you don't have Anaconda, follow the installation instructions:
     • Mac: https://garnet-rotate-01f.notion.site/Anaconda-Installation-Mac-487707ed7b5749bc92a168be8717b9be
     • Windows: https://garnet-rotate-01f.notion.site/Anaconda-Installation-Windows-a90983afbed448d29ab6f4fade6730d5

2. Create the Conda environment by following the instructions in: ./conda_environment/README.md

   • NOTE: This step only needs to be done once. Every subsquent time you want to run the analysis, you'll turn on the Conda environment with:
     • conda deactivate
     • conda activate {./path/to}/elo_rating_env

Step 3. Run each Data Processing/Analysis Jupyter Notebooks

1. Follow the instructions to run the Jupyter Notebooks at ./jupyter_notebooks/README.MD
   • NOTE: The dataframes and the plots should be saved in the subdirectories in the folder you created: Similar to./jupyter_notebooks/proc

Resources

ELO rating

• https://www.omnicalculator.com/sports/elo