codemetar package

[cboettig]

Summary

• What does this package do? (explain in 50 words or less):

Codemeta defines a 'JSON-LD' format for describing software metadata.
This package provides utilities to generate, parse, and modify codemeta.jsonld
files automatically for R packages.

• Paste the full DESCRIPTION file inside a code block below:

Package: codemetar
Type: Package
Title: Generate CodeMeta Metadata for R Packages
Version: 0.1.0
Authors@R: person("Carl", "Boettiger", role=c("aut", "cre", "cph"), email="cboettig@gmail.com", comment="http://orcid.org/0000-0002-1642-628X")
Description: Codemeta defines a 'JSON-LD' format for describing software metadata.
    This package provides utilities to generate, parse, and modify codemeta.jsonld
    files automatically for R packages.
License: MIT + file LICENSE
URL: https://github.com/codemeta/codemetar
BugReports: https://github.com/codemeta/codemetar/issues
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.0.1
Depends: R (>= 3.0.0)
Imports: jsonlite (>= 1.3),
    jsonld,
    git2r,
    devtools,
    methods,
    stringi
Suggests: testthat,
    jsonvalidate,
    covr,
    knitr,
    rmarkdown,
    httr,
    magrittr,
    readr,
    xml2
VignetteBuilder: knitr
keywords: metadata, codemeta, ropensci, citation, credit
affiliation: https://ropensci.org
relatedLink: https://codemeta.github.io/codemetar

• URL for the package (the development repository, not a stylized html page): https://github.com/codemeta/codemetar

• Please indicate which category or categories from our package fit policies this package falls under *and why(? (e.g., data retrieval, reproducibility. If you are unsure, we suggest you make a pre-submission inquiry.):

Package for creating and working with scientific software metadata

• Who is the target audience?

Academic researchers looking to create metadata for their software

• Are there other R packages that accomplish the same thing? If so, how does
  yours differ or meet our criteria for best-in-category?

Nope

Requirements

Confirm each of the following by checking the box. This package:

• does not violate the Terms of Service of any service it interacts with.
• has a CRAN and OSI accepted license.
• contains a README with instructions for installing the development version.
• includes documentation with examples for all functions.
• contains a vignette with examples of its essential functions and uses.
• has a test suite.
• has continuous integration, including reporting of test coverage, using services such as Travis CI, Coeveralls and/or CodeCov.
• I agree to abide by ROpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.

Publication options

• Do you intend for this package to go on CRAN?
• Do you wish to automatically submit to the Journal of Open Source Software? If so:
  • The package contains a paper.md with a high-level description in the package root or in inst/.
  • The package is deposited in a long-term repository with the DOI:
  • (Do not submit your package separately to JOSS)

Detail

• Does R CMD check (or devtools::check()) succeed? Paste and describe any errors or warnings:

• Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:

A few lines of code handle exceptional cases that are difficult to cover in unit tests. Otherwise no there should be no outstanding goodpractice flags in the repo.

• If this is a resubmission following rejection, please explain the change in circumstances:

• If possible, please provide recommendations of reviewers - those with experience with similar packages and/or likely users of your package - and their GitHub user names:

Perhaps anyone interested in metadata/archiving or just in messing around with json, maybe:

@amoeba @gothub @jennybc @sckott @stephlocke @jeroen @mfenner @o2r-project

[maelle]

Thanks for your submission @cboettig ! 😸 Looking for reviewers now. I also have two comments about one vignette and one test below.

Editor checks:

• [ x] Fit: The package meets criteria for fit and overlap
• [ x] Automated tests: Package has a testing suite and is tested via Travis-CI or another CI service.
• [ x] License: The package has a CRAN or OSI accepted license
• [ x] Repository: The repository link resolves correctly
• Archive (JOSS only, may be post-review): The repository DOI resolves correctly
• Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

---

Editor comments

• Nothing interesting from goodpractice::gp() 😉

• Issues (dplyr version, Appveyor failing test) disappeared after modifications, perfect.

---

Reviewers: @toph-allen @annakrystalli
Due date: 2017-08-07

[cboettig]

@maelle what version of dplyr are you using? as_tibble() is (once again) exported from dplyr as of the 0.7.0 release: https://github.com/tidyverse/dplyr/blame/master/NEWS.md#L48-L49

Re the cloned-repo test on Windows, the error I see on Appveyor comes from the devtools::use_build_ignore() function, and I couldn't find examples from any unit tests in the devtools package for that function so I'm a bit at a loss. Must have something to do with how Windows handles file paths, but not sure what. Does that devtools function work on windows with the default argument to pkg = "." for the path?

[maelle]

Ill look on Sunday or Monday but maybe add 0.7.0 as minimal version in DESCRIPTION?

For me the first error was bc of the file path, the beginning worked when omitting the / at the end but I'll look again in a few days and hopefully make a PR or suggestions. Windows user at your service! 😉

[maelle]

• I think I updated dplyr by mistake since writing my comment but I see you updated DESCRIPTION.

• Regarding the test failing on Windows see Windows fixes? codemetar#19

[maelle]

@annakrystalli @toph-allen Thanks a lot for accepting to review this package! Your reviews are due on the 2017-08-07.

As a reminder here is a link to the reviewing guide and here is one to the review template.

@cboettig you can be one of the first submitters to use test our new dynamic RO package status badge! You can add the following to your README.

[![](https://ropensci.org/badges/130_status.svg)](https://github.com/ropensci/onboarding/issues/130)

[annakrystalli]

No problem @maelle! Really interesting package @cboettig and excited to learn from the experience.