Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ropensci review comments #9

Closed
12 of 13 tasks
timelyportfolio opened this issue Mar 8, 2017 · 1 comment
Closed
12 of 13 tasks

ropensci review comments #9

timelyportfolio opened this issue Mar 8, 2017 · 1 comment

Comments

@timelyportfolio
Copy link
Contributor

linqtypology review

author: "Kenton Russell"
date: "March 8, 2017"

Package Review

Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide

  • 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).

Documentation

The package includes all the following forms of documentation:

  • A statement of need clearly stating problems the software is designed to solve and its target audience in README
  • Installation instructions: for the development version of package and any non-standard dependencies in README
  • Vignette(s) demonstrating major functionality that runs successfully locally
  • Function Documentation: for all exported functions in R help
  • Examples for all exported functions in R Help that run successfully locally
  • Community guidelines including contribution guidelines in the README or CONTRIBUTING, and URL, Maintainer and BugReports fields in DESCRIPTION

Functionality

  • Installation: Installation succeeds as documented.
  • Functionality: Any functional claims of the software been confirmed.
  • Performance: Any performance claims of the software been confirmed.
  • Automated tests: Unit tests cover essential functions of the package
    and a reasonable range of inputs and conditions. All tests pass on the local machine.
  • Packaging guidelines: The package conforms to the rOpenSci packaging guidelines

Final approval (post-review)

  • The author has responded to my review and made changes to my satisfaction. I recommend approving this package.

Estimated hours spent reviewing: 4


Review Comments

  1. Very thorough and well-written package with some quite nifty usage of leaflet.

  2. Add Date in DESCRIPTION as suggested in comment

  3. Add a quick example for makelink. Can be as simple as makelink("Adyghe"). Well done adding examples for all documented functions!

  4. Get 100% coverage :) So close, and to get there might be as simple as adding to test-lang-country.R. However, I could easily be mistaken.

expect_equal(lang.country(list("North Korea", "Lebanon")), c("Korean", "English", "French", "Assyrian Neo-Aramaic",
        "Northern Kurdish", "Armenian", "North Levantine Arabic", "Turoyo", "Chaldean Neo-Aramaic",
        "Standard Arabic", "Pidgin Madam"))
  1. Optional, but style code according to a styleguide (does ROpenSci have one?) to make more readable.
@timelyportfolio
Copy link
Contributor Author

closing in favor of ropensci/software-review#95 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant