The goal of codemetar is to generate the JSON-LD file, codemeta.json containing software metadata describing an R package. For more general information about the CodeMeta Project for defining software metadata, see https://codemeta.github.io. In particular, new users might want to start with the User Guide, while those looking to learn more about JSON-LD and consuming existing codemeta files should see the Developer Guide.
You can install codemetar from GitHub with:
# install.packages("devtools")
devtools::install_github("codemeta/codemetar")library("codemetar")This is a basic example which shows you how to generate a codemeta.json for an R package (e.g. for testthat):
write_codemeta("testthat")codemetar can take the path to the package root instead. This may allow codemetar to glean some additional information that is not available from the description file alone.
write_codemeta("."){
"@context": [
"https://doi.org/doi:10.5063/schema/codemeta-2.0",
"http://schema.org"
],
"@type": "SoftwareSourceCode",
"identifier": "testthat",
"description": "A unit testing system designed to be fun, flexible and easy to\n set up.",
"name": "testthat: Unit Testing for R",
"issueTracker": "https://github.com/hadley/testthat/issues",
"datePublished": "2016-04-23 08:37:40",
"license": "https://spdx.org/licenses/MIT",
"version": "1.0.2",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"version": "3.4.0",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 3.4.0 (2017-04-21)",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"author": [
{
"@type": "Person",
"givenName": "Hadley",
"familyName": "Wickham",
"email": "hadley@rstudio.com"
}
],
"copyrightHolder": [
{
"@type": "Organization",
"name": "RStudio"
}
],
"maintainer": {
"@type": "Person",
"givenName": "Hadley",
"familyName": "Wickham",
"email": "hadley@rstudio.com"
},
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "devtools",
"name": "devtools",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
},
{
"@type": "SoftwareApplication",
"identifier": "withr",
"name": "withr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
},
{
"@type": "SoftwareApplication",
"identifier": "covr",
"name": "covr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
}
],
"softwareRequirements": [
{
"@type": "SoftwareApplication",
"identifier": "digest",
"name": "digest",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
},
{
"@type": "SoftwareApplication",
"identifier": "crayon",
"name": "crayon",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
},
{
"@type": "SoftwareApplication",
"identifier": "praise",
"name": "praise",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
},
{
"@type": "SoftwareApplication",
"identifier": "magrittr",
"name": "magrittr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
},
{
"@type": "SoftwareApplication",
"identifier": "R6",
"name": "R6",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Central R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
},
{
"@type": "SoftwareApplication",
"identifier": "methods",
"name": "methods"
},
{
"@type": "SoftwareApplication",
"identifier": "R",
"name": "R",
"version": "3.1.0"
}
]
}The best way to ensure codemeta.json is as complete as possible is to begin by making full use of the fields that can be set in an R package DESCRIPTION file, such as BugReports and URL. Using the Authors@R notation allows a much richer specification of author roles, correct parsing of given vs family names, and email addresses.
In the current implementation, developers may specify an ORCID url for an author in the optional comment field of Authors@R, e.g.
Authors@R: person("Carl", "Boettiger", role=c("aut", "cre", "cph"), email="cboettig@gmail.com", comment="http://orcid.org/0000-0002-1642-628X")which will allow codemetar to associate an identifier with the person. This is clearly something of a hack since R’s person object lacks an explicit notion of id, and may be frowned upon.
The DESCRIPTION file is the natural place to specify any metadata for an R package. The codemetar package can detect certain additional terms in the CodeMeta context. Almost any additional codemeta field (see codemetar:::additional_codemeta_terms for a list) and can be added to and read from the DESCRIPTION into a codemeta.json file. Where applicable, these will override values otherwise guessed from the source repository. Use comma-separated lists to separate multiple values to a property, e.g. keywords.
See the DESCRIPTION file of the codemetar package for an example.
Check out all the codemetar vignettes for tutorials on other cool stuff you can do with codemeta and json-ld.