Comments (10)
Robert
On Sat, Jul 9, 2016, 11:46 PM Arfon Smith [email protected] wrote:
/ cc @openjournals/joss-reviewers
https://github.com/orgs/openjournals/teams/joss-reviewers - would
anyone be willing to review this submission?If you would like to review this submission then please comment on this
thread so that others know you're doing a review (so as not to duplicate
effort). Something as simple as✋ I am reviewing this will suffice.Reviewer instructions
- Please work through the checklist at the start of this issue.
- If you need any further guidance/clarification take a look at the
reviewer guidelines here
http://joss.theoj.org/about#reviewer_guidelines- Please make a publication recommendation at the end of your review
Any questions, please ask for help by commenting on this issue!
🚀 —
You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub
#37 (comment),
or mute the thread
https://github.com/notifications/unsubscribe/ABcI-sXux4l5ob24E5IVtyz1USGAYOc3ks5qUGsCgaJpZM4JIwRk
.
from joss-reviews.
@juliasilge - this is now accepted into JOSS. Your DOI is http://dx.doi.org/10.21105/joss.00037
from joss-reviews.
/ cc @openjournals/joss-reviewers - would anyone be willing to review this submission?
If you would like to review this submission then please comment on this thread so that others know you're doing a review (so as not to duplicate effort). Something as simple as :hand: I am reviewing this
will suffice.
Reviewer instructions
- Please work through the checklist at the start of this issue.
- If you need any further guidance/clarification take a look at the reviewer guidelines here http://joss.theoj.org/about#reviewer_guidelines
- Please make a publication recommendation at the end of your review
Any questions, please ask for help by commenting on this issue!
from joss-reviews.
I will mention @dgrtwo here so he can follow along as well.
from joss-reviews.
Regarding LICENSE, the LICENSE is the standard CRAN implementation of the MIT LICENSE, which while not exactly standard for OSS, is the standard for CRAN. Therefore I am checking it off.
from joss-reviews.
Below is my review, which is basically copy pasting the above checklist, with some commentary interspersed. All checked off, I recommend to publish as-is.
@juliasilge and @dgrtwo: one of the vignettes installing from CRAN did not have the correct title, but I see in the github repo it has been corrected, so no issues. That was the only beef I had.
Reviewer questions
Conflict of interest
- As the reviewer I confirm that there are no conflicts of interest for me to review this work (such as being a major contributor to the software).
General checks
- Repository: Is the source code for this software available at the repository url?
- License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
Regarding LICENSE, the LICENSE is the standard CRAN implementation of the MIT LICENSE, which while not exactly standard for OSS, is the standard for CRAN. Therefore I am checking it off.
- Version: Does the release version given match the GitHub release (v0.1.1)?
Functionality
- Installation: Does installation proceed as outlined in the documentation?
- Functionality: Have the functional claims of the software been confirmed?
- Performance: Have any performance claims of the software been confirmed?
Documentation
- A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
- Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
dependencies are handled by the R package installation
- Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
The README provides well worked examples showing how the software works, on a real dataset
Various functions have examples, and also included are 4 vignettes (R long-form documentation) that also demonstrate various analyses.
- Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g. API method documentation)?
- Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
- Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support
Software paper
Paper PDF: 10.21105.joss.00037.pdf
- Authors: Does the
paper.md
file include a list of authors with their affiliations? - A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
- References: Do all archival references that should have a DOI list one (e.g. papers, datasets, software)?
Issues with Submission
The CRAN installed version does not have the correct title for one of the vignettes, but I would think that it will propagate soon.
Recommendation
Publish as-is
from joss-reviews.
Regarding the package's LICENSE, I did try submitting to CRAN with the contents of the whole MIT license in the LICENSE file, as discussed in the author guidelines, but the CRAN administrators did not go for it.
from joss-reviews.
Right, and I figured that was an issue. That is why I just checked it anyway, because you followed the CRAN guidelines, which is where the package is "published" for ease of installation purposes.
from joss-reviews.
Thanks for the rapid review @rmflight!
@juliasilge - the final thing here is to make an archive of the software in Zenodo/figshare/other similar service and update this thread with the archive DOI. I can then move forward with accepting this submission
from joss-reviews.
I turned on Zenodo before our last, most recent release so there is an archive of v0.1.1, the current version and what is on CRAN right now:
Let me know if anything needs to be changed about that, or if I need to make another release for the JOSS submission specifically or anything like that.
from joss-reviews.
Related Issues (20)
- [REVIEW]: BASICO: A simplified python interface to COPASI HOT 7
- [REVIEW]: Effluent - A python package for modelling effluent discharge HOT 6
- [PRE REVIEW]: PROFFASTpylot: Running PROFFAST with Python HOT 6
- [REVIEW]: PASCal Python: A Principal Axis Strain Calculator HOT 15
- [PRE REVIEW]: MacroModelling.jl: A Julia package for developing and solving dynamic stochastic general equilibrium models HOT 13
- [PRE REVIEW]: Port: A software tool for digital data donation HOT 20
- [PRE REVIEW]: adverseimpact: An R package to compute statistical indicators of adverse impact in selection decisions HOT 5
- [PRE REVIEW]: Zoomerjoin: Superlatively Fast Fuzzy-Joins HOT 8
- [REVIEW]: neotoma2: An R package to access data from the Neotoma Paleoecology Database HOT 14
- [REVIEW]: DARTS: The Data Analysis Remote Treatment Service HOT 7
- [REVIEW]: SMITE: Single Molecule Imaging Toolbox Extraordinaire (MATLAB) HOT 9
- [REVIEW]: SBArchOpt: Surrogate-Based Architecture Optimization HOT 6
- [REVIEW]: SyntheticEddyMethod.jl: A Julia package for the creation of inlet flow conditions for LES HOT 12
- [REVIEW]: Reducing the efforts to create reproducible analysis code with FieldTrip HOT 8
- [REVIEW]: COOLEST: the COde-independent Organized LEns STandard HOT 7
- [PRE REVIEW]: pyheartlib: A Python package for processing electrocardiogram signals HOT 18
- [PRE REVIEW]: PlanetMapper: A Python package for visualising, navigating and mapping Solar System observations HOT 5
- [REVIEW]: Time-frequency component of the Green-X library: minimax grids for efficient RPA and GW calculations HOT 9
- [REVIEW]: Triumvirate: A Python/C++ package for three-point clustering measurements HOT 5
- [REVIEW]: dsmmR: Estimation and Simulation of Drifting Semi-Markov Models HOT 8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from joss-reviews.