The OpenScope Databook: Reproducible System Neuroscience Notebooks to Facilitate Data Sharing and Collaborative Reuse with Open Science Datasets
Creators
- Ager, Katrina (Researcher)
-
Akella, Shailaja
(Researcher)1, 2
- Bawany, Ahad (Researcher)1, 2
-
Bennett, Corbett
(Researcher)1, 2
-
Dichter, Benjamin
(Researcher)3
-
Ghosh, Satrajit
(Researcher)4
-
Gillon, Colleen J.
(Researcher)5
- Halchenko, Yaroslav (Researcher)
-
Hulsey, Daniel
(Researcher)6
-
Jaramillo, Santiago
(Researcher)6
-
Jia, Xiaoxuan
(Researcher)7
-
Kim, Yeerim
(Researcher)8
- Kiselycznyk, Carly (Researcher)1, 2
-
Lecoq, Jérôme
(Researcher)1, 2
-
Mathis, Mackenzie
(Researcher)9
-
Peene, R. Carter
(Contact person)1, 2
-
Prince, Stephanie
(Researcher)10
-
Pina, Jason
(Researcher)11
- Shin, Hyeyoung (Researcher)8
- Siegle, Josh (Researcher)1, 2
-
Song, Jiatai
(Researcher)7
-
Tseng, Shih-Yi
(Researcher)12
-
Westerberg, Jacob
(Researcher)13
-
Williams, Alex
(Researcher)14
-
1.
Allen Institute
-
2.
Allen Institute for Neural Dynamics
-
3.
CatalystNeuro
-
4.
Massachusetts Institute of Technology
-
5.
Imperial College London
-
6.
University of Oregon
-
7.
Tsinghua University
-
8.
Seoul National University
- 9. Swiss Federal Institute of Technology in Lausanne
-
10.
Lawrence Berkeley National Laboratory
-
11.
York University
-
12.
University of California, San Francisco
-
13.
Netherlands Institute for Neuroscience
-
14.
New York University
Description
Reproducibility is a significant challenge in neuroscience, as analysis and visualization methods are often difficult to replicate due to a lack of accessible code, separation of code from published figures, or unavailability of code altogether. This issue may arise from the complex nature of neuroscience research, the use of diverse data formats and analysis techniques, and insufficient emphasis on open-source, collaborative practices. In addition, key neuroscience analyses are typically rewritten at the start of new scientific projects, slowing down the initiation of research efforts.
Four key components are essential for reproducible analysis: accessible data, accessible computational resources, a reproducible environment, and usage documentation. The OpenScope Databook, provided by the Allen Institute’s OpenScope Project, offers a solution to these challenges by facilitating the analysis and visualization of brain data, primarily using NWB files and the DANDI archive. Hosted on Github, the entire publication – including code, data access, text, references, and revisions from reviewers and contributors – is readily available for collaboration and version control, promoting transparency and collective knowledge growth. The OpenScope Databook addresses these components by leveraging a combination of open-source Python libraries, such as DANDI, Binder, Jupyter Book, Google Colab, LaTeX references, Python scripts, Git versioning, and scientific revision through approved pull requests. The entire publication can be recreated by running the code locally, on distributed servers such as Binder, DandiHub, or Google Colab, or on any host running Jupyter notebooks.
We cover several broadly used analyses across the community, providing a missing component for system neuroscience. Our key analyses are organized into chapters, including NWB basics such as downloading, streaming, and visualizing NWB files from data archives. We document essential analyses typically performed in all neuroscience laboratories, such as temporal alignment, alignment to sensory stimuli, and association with experimental metadata. We cover the two leading neuronal recording techniques: two-photon calcium imaging and electrophysiological recordings, and share example analyses of stimulus-averaged responses. Advanced first-order analyses include showing receptive fields, identifying optotagged units, current source density analysis, and cell matching across days.
This resource is actively maintained on GitHub here https://github.com/AllenInstitute/openscope_databook, and deployed through GitHub Pages here https://alleninstitute.github.io/openscope_databook . The project can be updated by the community, providing a living document that will grow over time.
Files
AllenInstitute/openscope_databook-v1.2.0.zip
Files
(42.4 MB)
Name | Size | Download all |
---|---|---|
md5:58c6d317e1b20447597c7c891fd81539
|
42.4 MB | Preview Download |
Additional details
Related works
- Is supplement to
- Software: https://github.com/AllenInstitute/openscope_databook/tree/v1.2.0 (URL)
Funding
- National Institutes of Health
- A community-driven brain observatory for large-scale systems neuroscience U24 NS113646
- National Institutes of Health
- DANDI: Distributed Archives for Neurophysiology Data Integration R24MH117295
- National Institutes of Health
- Expanding access to open-source data acquisition software for next-generation silicon probes U24 NS109043
Dates
- Created
-
2024-07-01Deployment via Github with reviews through pull request
Software
- Repository URL
- https://alleninstitute.github.io/openscope_databook/
- Programming language
- Python, Jupyter Notebook
- Development Status
- Active