Skip to content

Commit 7de5734

Browse files
authored
Merge pull request #23 from kabilar/main
Update README
2 parents 829f416 + 20f3815 commit 7de5734

File tree

2 files changed

+26
-24
lines changed

2 files changed

+26
-24
lines changed

Background.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
11
# DataJoint Element - Animal
22

3+
+ `element-animal` features a DataJoint pipeline design for subject and genotyping management.
4+
5+
+ `element-animal` is not a complete workflow by itself, but rather a modular design of tables and dependencies.
6+
7+
+ `element-animal` can be flexibly attached to any DataJoint workflow.
8+
9+
+ See the [Element Animal documentation](https://elements.datajoint.org/description/animal/) for the background information and development timeline.
10+
11+
+ For more information on the DataJoint Elements project, please visit https://elements.datajoint.org. This work is supported by the National Institutes of Health.
12+
13+
## Element architecture
14+
315
There are two modules in `element-animal`:
416
+ subject: contains the basic information of subject, including Strain, Line, Subject, Zygosity, and SubjectDeath information
517
+ genotyping: this module is designed for labs that keep track of colony management and genotyping results, containing information of breeding, weaning, housing, and genotyping.
618

7-
See [Background](Background.md) for the background information and development timeline.
19+
### Subject Diagram
20+
![subject diagram](images/subject_diagram.svg)
821

22+
### Genotyping Diagram
23+
![genotyping diagram](images/genotyping_diagram.svg)
924

1025
## Installation
1126
```
@@ -20,18 +35,21 @@ pip install --upgrade element-animal
2035
## Element usage
2136

2237
+ `element-animal` is not a complete workflow by itself, but rather a modular design of tables and dependencies that can be flexibly attached to any DataJoint workflow.
23-
+ See the [workflow-animal](https://github.com/datajoint/workflow-animal) repository for example usage of `element-animal`.
38+
39+
+ See the [workflow-session](https://github.com/datajoint/workflow-session) repository for example usage of `element-animal`.
2440

2541
+ Also refer to the [workflow-calcium-imaging](https://github.com/datajoint/workflow-calcium-imaging) and [workflow-array-ephys](https://github.com/datajoint/workflow-array-ephys) repositories for example usages of `element-animal` when combining with other elements.
2642

27-
+ See the [datajoint-elements](https://github.com/datajoint/datajoint-elements) repository for a detailed description of the DataJoint elements and workflows.
43+
## Citation
2844

29-
## Element architecture
45+
+ If your work uses DataJoint and DataJoint Elements, please cite the respective Research Resource Identifiers (RRIDs) and manuscripts.
3046

31-
### Subject Diagram
32-
![subject diagram](images/subject_diagram.svg)
47+
+ DataJoint for Python or MATLAB
48+
+ Yatsenko D, Reimer J, Ecker AS, Walker EY, Sinz F, Berens P, Hoenselaar A, Cotton RJ, Siapas AS, Tolias AS. DataJoint: managing big scientific data using MATLAB or Python. bioRxiv. 2015 Jan 1:031658. doi: https://doi.org/10.1101/031658
3349

34-
### Genotyping Diagram
35-
![genotyping diagram](images/genotyping_diagram.svg)
50+
+ DataJoint ([RRID:SCR_014543](https://scicrunch.org/resolver/SCR_014543)) - DataJoint for `<Select Python or MATLAB>` (version `<Enter version number>`)
3651

52+
+ DataJoint Elements
53+
+ Yatsenko D, Nguyen T, Shen S, Gunalan K, Turner CA, Guzman R, Sasaki M, Sitonic D, Reimer J, Walker EY, Tolias AS. DataJoint Elements: Data Workflows for Neurophysiology. bioRxiv. 2021 Jan 1. doi: https://doi.org/10.1101/2021.03.30.437358
3754

55+
+ DataJoint Elements ([RRID:SCR_021894](https://scicrunch.org/resolver/SCR_021894)) - Element Animal (version `<Enter version number>`)

0 commit comments

Comments
 (0)