mTRFpy
mTRFpy: A Python package for temporal response function analysis - Published in JOSS (2023)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 9 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
2 of 6 committers (33.3%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
a python3 version of matlab mTRF-Toolbox by Lalor Lab https://mtrfpy.readthedocs.io/
Basic Info
Statistics
- Stars: 32
- Watchers: 4
- Forks: 14
- Open Issues: 6
- Releases: 7
Topics
Metadata Files
README.md
mTRFpy - multivariate linear modeling
This is an adaptation of the matlab mTRF-toolbox using only basic Python and Numpy. It aims to implement the same methods as the original toolbox and advance them. This documentation provides tutorial-like demonstrations of the core functionalities like model fitting, visualization and optimization as well as a comprehensive reference documentation.
Installation
You can get the stable release from PyPI:
sh
pip install mtrf
Or get the latest version from this repo:
sh
pip install git+https://github.com/powerfulbean/mTRFpy.git
While mTRFpy only depends on numpy, matplotlib is an optional dependency used to visualize models. It can also be installed via pip:
sh
pip install matplotlib
We also provide an optional interface to MNE-Python so it might be useful to install mne as well.
Getting started
For a little tutorial on the core features of mTRFpy, have a look at our online documentation
Found a bug?
- Please use the issue search to check if the issue has already been reportet.
- Try to reproduce problem using the latest
masterbranch. - Create an issue with a minimal example that reproduces the problem.
Missing a feature?
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
Want to contribute to the project?
Great! Please take a moment to read the before you do.
Citing mTRFpy
Bialas et al., (2023). mTRFpy: A Python package for temporal response function analysis. Journal of Open Source Software, 8(89), 5657, https://doi.org/10.21105/joss.05657
@article{Bialas2023,
doi = {10.21105/joss.05657},
url = {https://doi.org/10.21105/joss.05657},
year = {2023}, publisher = {The Open Journal},
volume = {8},
number = {89},
pages = {5657},
author = {Ole Bialas and Jin Dou and Edmund C. Lalor},
title = {mTRFpy: A Python package for temporal response function analysis},
journal = {Journal of Open Source Software} }
Owner
- Name: Jin Dou
- Login: powerfulbean
- Kind: user
- Website: powerfulbean.github.io
- Repositories: 3
- Profile: https://github.com/powerfulbean
JOSS Publication
mTRFpy: A Python package for temporal response function analysis
Authors
Department of Biomedical Engineering, University of Rochester, USA
Department of Biomedical Engineering, University of Rochester, USA
Department of Biomedical Engineering, University of Rochester, USA, Department of Neuroscience, University of Rochester, USA
Editor
Britta Westner
Tags
electrophysiology temporal response function cognitive neuroscience computational neuroscience TRFCitation (CITATION.cff)
cff-version: "1.2.0"
authors:
- family-names: Bialas
given-names: Ole
orcid: "https://orcid.org/0000-0003-4472-7626"
- family-names: Dou
given-names: Jin
orcid: "https://orcid.org/0009-0000-0539-5951"
- family-names: Lalor
given-names: Edmund C.
orcid: "https://orcid.org/0000-0002-2498-6631"
contact:
- family-names: Bialas
given-names: Ole
orcid: "https://orcid.org/0000-0003-4472-7626"
doi: 10.5281/zenodo.8321912
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Bialas
given-names: Ole
orcid: "https://orcid.org/0000-0003-4472-7626"
- family-names: Dou
given-names: Jin
orcid: "https://orcid.org/0009-0000-0539-5951"
- family-names: Lalor
given-names: Edmund C.
orcid: "https://orcid.org/0000-0002-2498-6631"
date-published: 2023-09-12
doi: 10.21105/joss.05657
issn: 2475-9066
issue: 89
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 5657
title: "mTRFpy: A Python package for temporal response function
analysis"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.05657"
volume: 8
title: "mTRFpy: A Python package for temporal response function
analysis"
GitHub Events
Total
- Create event: 2
- Release event: 1
- Issues event: 3
- Watch event: 5
- Issue comment event: 8
- Push event: 6
- Pull request event: 1
- Fork event: 5
Last Year
- Create event: 2
- Release event: 1
- Issues event: 3
- Watch event: 5
- Issue comment event: 8
- Push event: 6
- Pull request event: 1
- Fork event: 5
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Ole Bialas | o****s@p****e | 177 |
| Jin Dou | j****3@u****u | 119 |
| Stefan Appelhoff | s****f@m****g | 10 |
| Britta Westner | b****r@g****m | 5 |
| ruix6 | 2****5@c****n | 1 |
| Bernd Accou | b****u@k****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 17
- Total pull requests: 20
- Average time to close issues: 27 days
- Average time to close pull requests: 14 days
- Total issue authors: 8
- Total pull request authors: 7
- Average comments per issue: 2.35
- Average comments per pull request: 0.65
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 4
Past Year
- Issues: 2
- Pull requests: 1
- Average time to close issues: 9 days
- Average time to close pull requests: N/A
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 3.5
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- sappelhoff (5)
- powerfulbean (4)
- mamadyonline (3)
- xinyiguan (1)
- zoldello (1)
- OleBialas (1)
Pull Request Authors
- powerfulbean (6)
- sappelhoff (5)
- dependabot[bot] (4)
- britta-wstnr (2)
- OleBialas (2)
- berndie (1)
- ruix6 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 370 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 10
- Total maintainers: 1
pypi.org: mtrf
Tools for modeling brain responses using (multivariate)temporal response functions.
- Homepage: http://github.com/powerfulbean/mTRFpy
- Documentation: https://mtrf.readthedocs.io/
- License: MIT
-
Latest release: 2.0.5
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite
- numpy *