AnimalProfile

A package for tagging animal experiments


License
MIT
Install
pip install AnimalProfile==0.1

Documentation

AnimalProfile

A python package for tagging animal experiments.

This package allows assigning tags and parameters to animals and experiments, to keep track of them and group similar conditions together. Here is an example of a profile file for an animal:

A screenshot of an example profile

A similar file for each animal is created which consists of:

  • header parameters, which are labels for each animal. such as its genetic background, its initial training method, etc. In this example, 3 parameters are defined:

"rewardType", "initialSpeed", and "option". The "name" field is added automatically.

  • body, seperated from the header by lack of a leading # character, consists of at least a Sessions column and a Tag column (added automatically). The `Sessions columns lists all the experiments, the Tag column should include a descriptive and unique label for the experimental condition (e.g., Early-Lesion-DLS). User can add more columns to the body (3 more columns in this example).

This package:

  • detects new experiments, adds them to the profile file.
  • provides an interface for reading the profiles and grouping similar experiments for furthur analysis.

Data structure

Data must be structured in a particular format.

Basic usage

Instructions are here.

Installation

Requirements