JOSS-paper/reviewer-checklist.md
In rrrlw/TDAstats: Pipeline for Topological Data Analysis
JOSS reviewer checklist
- Requirements for paper.md: all of the components below are included in paper.md
- list of authors of software
- author affiliations
- summary for non-specialist audience
- statement of need/purpose of software
- ongoing research projects using software
- list of key references
- Software license: plaintext LICENSE file present for GPL-3 (OSI-approved)
- High-level documentation: README.md file present with purpose, installation instructions (dependencies in DESCRIPTION file), and example usage (more detailed examples in vignettes folder)
- API documentation: all public functions have appropriate documentation; non-plotting functions have examples
- Community guidelines
- Functionality: vignettes (compile Rmarkdown from vignettes folder, or use devtools::build_vignettes() after installing package. Upon request, can also email HTML of built vignettes) introduce functionality
- Tests: tests folder contains automated testing suite using testthat R package
- Novelty of software: TDA package in R does have overlapping functionality, but TDAstats calculates homology faster (see https://github.com/Ripser/ripser for details), allows modifications of plots through ggplot2 (more customizable, reproducible graph), and allows for hypothesis testing with permutation tests (which no TDA software known to us implements)
- Development environment: the R programming language and the corresponding IDE (Rstudio) are open-source and free
rrrlw/TDAstats documentation built on Nov. 24, 2021, 3:53 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
JOSS reviewer checklist
- Requirements for paper.md: all of the components below are included in paper.md
- list of authors of software
- author affiliations
- summary for non-specialist audience
- statement of need/purpose of software
- ongoing research projects using software
- list of key references
- Software license: plaintext LICENSE file present for GPL-3 (OSI-approved)
- High-level documentation: README.md file present with purpose, installation instructions (dependencies in DESCRIPTION file), and example usage (more detailed examples in vignettes folder)
- API documentation: all public functions have appropriate documentation; non-plotting functions have examples
- Community guidelines
- Functionality: vignettes (compile Rmarkdown from vignettes folder, or use devtools::build_vignettes() after installing package. Upon request, can also email HTML of built vignettes) introduce functionality
- Tests: tests folder contains automated testing suite using testthat R package
- Novelty of software: TDA package in R does have overlapping functionality, but TDAstats calculates homology faster (see https://github.com/Ripser/ripser for details), allows modifications of plots through ggplot2 (more customizable, reproducible graph), and allows for hypothesis testing with permutation tests (which no TDA software known to us implements)
- Development environment: the R programming language and the corresponding IDE (Rstudio) are open-source and free
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.