diff --git a/README.md b/README.md index e28268e8..27799c27 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,8 @@ Which creates a file looking like so (first 10 lines; see full [codemeta.json he ], "@type": "SoftwareSourceCode", "identifier": "codemetar", - "description": "The 'Codemeta' Project defines a 'JSON-LD' format for describing\n software metadata, as detailed at . This package\n provides utilities to generate, parse, and modify 'codemeta.jsonld' files \n automatically for R packages, as well as tools and examples for working with\n 'codemeta' 'JSON-LD' more generally.", - "name": "codemetar: Generate CodeMeta Metadata for R Packages", + "description": "The 'Codemeta' Project defines a 'JSON-LD' format for describing\n software metadata, as detailed at . This package\n provides utilities to generate, parse, and modify 'codemeta.json' files \n automatically for R packages, as well as tools and examples for working with\n 'codemeta.json' 'JSON-LD' more generally.", + "name": "codemetar: Generate 'CodeMeta' Metadata for R Packages", "issueTracker": "https://github.com/ropensci/codemetar/issues", Modifying or enriching CodeMeta metadata diff --git a/codemeta.json b/codemeta.json index df1baabe..edfbd69f 100644 --- a/codemeta.json +++ b/codemeta.json @@ -5,11 +5,11 @@ ], "@type": "SoftwareSourceCode", "identifier": "codemetar", - "description": "The 'Codemeta' Project defines a 'JSON-LD' format for describing\n software metadata, as detailed at . This package\n provides utilities to generate, parse, and modify 'codemeta.jsonld' files \n automatically for R packages, as well as tools and examples for working with\n 'codemeta' 'JSON-LD' more generally.", - "name": "codemetar: Generate CodeMeta Metadata for R Packages", + "description": "The 'Codemeta' Project defines a 'JSON-LD' format for describing\n software metadata, as detailed at . This package\n provides utilities to generate, parse, and modify 'codemeta.json' files \n automatically for R packages, as well as tools and examples for working with\n 'codemeta.json' 'JSON-LD' more generally.", + "name": "codemetar: Generate 'CodeMeta' Metadata for R Packages", "issueTracker": "https://github.com/ropensci/codemetar/issues", "license": "https://spdx.org/licenses/MIT", - "version": "0.1.3", + "version": "0.1.4", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", @@ -276,5 +276,5 @@ "developmentStatus": "active", "releaseNotes": "https://github.com/ropensci/codemetar/blob/master/NEWS.md", "readme": "https://github.com/ropensci/codemetar/blob/master/README.md", - "fileSize": "658.171KB" + "fileSize": "266.369KB" } diff --git a/cran-comments.md b/cran-comments.md index 260f7a72..a7255a47 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -10,6 +10,7 @@ Carl ## Test environments + * local OS X install, R 3.4.3 * ubuntu 16.04 (on travis-ci), R 3.4.3 * win-builder (devel and release) diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 0f1e6a29..2101b05f 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • diff --git a/docs/articles/A-codemeta-intro.html b/docs/articles/A-codemeta-intro.html index 03550b4f..a8396ec7 100644 --- a/docs/articles/A-codemeta-intro.html +++ b/docs/articles/A-codemeta-intro.html @@ -54,7 +54,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -84,7 +84,7 @@

    Codemeta intro

    Carl Boettiger

    -

    2018-01-25

    +

    2018-02-12

    @@ -126,9 +126,9 @@

    Example

    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")
    +
    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.

    - +
    {
       "@context": [
         "http://purl.org/codemeta/2.0",
    diff --git a/docs/articles/B-translating.html b/docs/articles/B-translating.html
    index 9b4c5662..0dbc6bbf 100644
    --- a/docs/articles/B-translating.html
    +++ b/docs/articles/B-translating.html
    @@ -54,7 +54,7 @@
           Validation in JSON-LD
         
         
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -84,7 +84,7 @@

    Translating between schema using JSON-LD

    Carl Boettiger

    -

    2018-01-25

    +

    2018-02-12

    @@ -143,7 +143,7 @@

    repo_info %>% toJSON()
    {"id":[10894022],"name":["EML"],"full_name":["ropensci/EML"],"owner":{"login":["ropensci"],"id":[1200269],"avatar_url":["https://avatars0.githubusercontent.com/u/1200269?v=3"],"gravatar_id":[""],"url":["https://api.github.com/users/ropensci"],"html_url":["https://github.com/ropensci"],"followers_url":["https://api.github.com/users/ropensci/followers"],"following_url":["https://api.github.com/users/ropensci/following{/other_user}"],"gists_url":["https://api.github.com/users/ropensci/gists{/gist_id}"],"starred_url":["https://api.github.com/users/ropensci/starred{/owner}{/repo}"],"subscriptions_url":["https://api.github.com/users/ropensci/subscriptions"],"organizations_url":["https://api.github.com/users/ropensci/orgs"],"repos_url":["https://api.github.com/users/ropensci/repos"],"events_url":["https://api.github.com/users/ropensci/events{/privacy}"],"received_events_url":["https://api.github.com/users/ropensci/received_events"],"type":["Organization"],"site_admin":[false]},"private":[false],"html_url":["https://github.com/ropensci/EML"],"description":[" Ecological Metadata Language interface for R: synthesis and integration of heterogenous data"],"fork":[false],"url":["https://api.github.com/repos/ropensci/EML"],"forks_url":["https://api.github.com/repos/ropensci/EML/forks"],"keys_url":["https://api.github.com/repos/ropensci/EML/keys{/key_id}"],"collaborators_url":["https://api.github.com/repos/ropensci/EML/collaborators{/collaborator}"],"teams_url":["https://api.github.com/repos/ropensci/EML/teams"],"hooks_url":["https://api.github.com/repos/ropensci/EML/hooks"],"issue_events_url":["https://api.github.com/repos/ropensci/EML/issues/events{/number}"],"events_url":["https://api.github.com/repos/ropensci/EML/events"],"assignees_url":["https://api.github.com/repos/ropensci/EML/assignees{/user}"],"branches_url":["https://api.github.com/repos/ropensci/EML/branches{/branch}"],"tags_url":["https://api.github.com/repos/ropensci/EML/tags"],"blobs_url":["https://api.github.com/repos/ropensci/EML/git/blobs{/sha}"],"git_tags_url":["https://api.github.com/repos/ropensci/EML/git/tags{/sha}"],"git_refs_url":["https://api.github.com/repos/ropensci/EML/git/refs{/sha}"],"trees_url":["https://api.github.com/repos/ropensci/EML/git/trees{/sha}"],"statuses_url":["https://api.github.com/repos/ropensci/EML/statuses/{sha}"],"languages_url":["https://api.github.com/repos/ropensci/EML/languages"],"stargazers_url":["https://api.github.com/repos/ropensci/EML/stargazers"],"contributors_url":["https://api.github.com/repos/ropensci/EML/contributors"],"subscribers_url":["https://api.github.com/repos/ropensci/EML/subscribers"],"subscription_url":["https://api.github.com/repos/ropensci/EML/subscription"],"commits_url":["https://api.github.com/repos/ropensci/EML/commits{/sha}"],"git_commits_url":["https://api.github.com/repos/ropensci/EML/git/commits{/sha}"],"comments_url":["https://api.github.com/repos/ropensci/EML/comments{/number}"],"issue_comment_url":["https://api.github.com/repos/ropensci/EML/issues/comments{/number}"],"contents_url":["https://api.github.com/repos/ropensci/EML/contents/{+path}"],"compare_url":["https://api.github.com/repos/ropensci/EML/compare/{base}...{head}"],"merges_url":["https://api.github.com/repos/ropensci/EML/merges"],"archive_url":["https://api.github.com/repos/ropensci/EML/{archive_format}{/ref}"],"downloads_url":["https://api.github.com/repos/ropensci/EML/downloads"],"issues_url":["https://api.github.com/repos/ropensci/EML/issues{/number}"],"pulls_url":["https://api.github.com/repos/ropensci/EML/pulls{/number}"],"milestones_url":["https://api.github.com/repos/ropensci/EML/milestones{/number}"],"notifications_url":["https://api.github.com/repos/ropensci/EML/notifications{?since,all,participating}"],"labels_url":["https://api.github.com/repos/ropensci/EML/labels{/name}"],"releases_url":["https://api.github.com/repos/ropensci/EML/releases{/id}"],"deployments_url":["https://api.github.com/repos/ropensci/EML/deployments"],"created_at":["2013-06-23T23:20:03Z"],"updated_at":["2017-05-11T21:24:40Z"],"pushed_at":["2017-07-05T18:52:34Z"],"git_url":["git://github.com/ropensci/EML.git"],"ssh_url":["git@github.com:ropensci/EML.git"],"clone_url":["https://github.com/ropensci/EML.git"],"svn_url":["https://github.com/ropensci/EML"],"homepage":["https://ropensci.github.io/EML"],"size":[5094],"stargazers_count":[48],"watchers_count":[48],"language":["HTML"],"has_issues":[true],"has_projects":[true],"has_downloads":[true],"has_wiki":[true],"has_pages":[true],"forks_count":[17],"mirror_url":{},"open_issues_count":[35],"forks":[17],"open_issues":[35],"watchers":[48],"default_branch":["master"],"organization":{"login":["ropensci"],"id":[1200269],"avatar_url":["https://avatars0.githubusercontent.com/u/1200269?v=3"],"gravatar_id":[""],"url":["https://api.github.com/users/ropensci"],"html_url":["https://github.com/ropensci"],"followers_url":["https://api.github.com/users/ropensci/followers"],"following_url":["https://api.github.com/users/ropensci/following{/other_user}"],"gists_url":["https://api.github.com/users/ropensci/gists{/gist_id}"],"starred_url":["https://api.github.com/users/ropensci/starred{/owner}{/repo}"],"subscriptions_url":["https://api.github.com/users/ropensci/subscriptions"],"organizations_url":["https://api.github.com/users/ropensci/orgs"],"repos_url":["https://api.github.com/users/ropensci/repos"],"events_url":["https://api.github.com/users/ropensci/events{/privacy}"],"received_events_url":["https://api.github.com/users/ropensci/received_events"],"type":["Organization"],"site_admin":[false]},"network_count":[17],"subscribers_count":[18]} 

    We can crosswalk this information into codemeta just by supplying the column name to the crosswalk function. This performs the same expansion of the metadata in the GitHub context, followed by compaction into the codemeta context. Note that terms not recognized/included in the codemeta context will be dropped:

    -
    github_meta <- crosswalk(repo_info, "GitHub")
    +
    github_meta <- crosswalk(repo_info, "GitHub")
     github_meta
    {
       "@context": "http://purl.org/codemeta/2.0",
    @@ -158,7 +158,7 @@ 

    "issueTracker": "https://api.github.com/repos/ropensci/EML/issues{/number}" }

    We can verify that the result is a valid codemeta document:

    -
    codemeta_validate(github_meta)
    +
    codemeta_validate(github_meta)
    [1] TRUE
    @@ -166,8 +166,8 @@

    Transforming into other column schema

    The above transform showed the process of going from plain JSON data into the codemeta standard serialization. Similarly, we can crosswalk into any of the other columns in the crosswalk table. To do so, the crosswalk function will first expand any of the recognized properties into the codemeta JSON-LD context, just as above. Unrecognized properties are dropped, since there is no consensus context into which we can expand them. Second, the expanded terms are then compacted down into the new context (Zenodo in this case.) This time, any terms that are not part of the codemeta context are kept, but not compacted, since they still have meaningful contexts (that is, full URIs, e.g. URLs) that can be associated with them:

    -
    crosswalk(repo_info, "GitHub", "Zenodo") %>%
    -drop_context()
    +
    crosswalk(repo_info, "GitHub", "Zenodo") %>%
    +drop_context()
    {
       "relatedLink": "https://github.com/ropensci/EML",
       "schema:dateCreated": {
    @@ -254,7 +254,7 @@ 

    $license [1] "MIT"

    -
    crosswalk(package.json, "NodeJS")
    +
    crosswalk(package.json, "NodeJS")
    {
       "@context": "http://purl.org/codemeta/2.0",
       "codeRepository": {},
    diff --git a/docs/articles/C-validation-in-json-ld.html b/docs/articles/C-validation-in-json-ld.html
    index 69721c04..f18abc8d 100644
    --- a/docs/articles/C-validation-in-json-ld.html
    +++ b/docs/articles/C-validation-in-json-ld.html
    @@ -54,7 +54,7 @@
           Validation in JSON-LD
         
         
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -84,7 +84,7 @@

    Validation in JSON-LD

    Carl Boettiger

    -

    2018-01-25

    +

    2018-02-12

    diff --git a/docs/articles/D-codemeta-parsing.html b/docs/articles/D-codemeta-parsing.html index a9488f68..448bedef 100644 --- a/docs/articles/D-codemeta-parsing.html +++ b/docs/articles/D-codemeta-parsing.html @@ -5,7 +5,7 @@ -Parsing Codmeta Data • codemetar +Parsing Codemeta Data • codemetar @@ -54,7 +54,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -81,10 +81,10 @@
    @@ -100,7 +100,7 @@

    2018-01-25

    library(printr) library(tibble)

    We start with a simple example from the codemeta.json file of codemetar itself. First, we’ll just generate a copy of the codemeta record for the package:

    -
    write_codemeta("codemetar", "codemeta.json")
    +
    write_codemeta("codemetar", "codemeta.json")

    We then digest this input using a JSON-LD “frame.” While not strictly necessary, this helps ensure the data matches the format we expect, even if the original file had errors or missing data. See the vignette “Validating in JSON-LD” in this package and the official JSON-LD docs for details). The codemetar package includes a reasonably explicit frame to get us started:

    frame <- system.file("schema/frame_schema.json", package="codemetar")
     
    @@ -133,13 +133,13 @@ 

    2018-01-25

    be recycled: author
    cat(format(bibitem, "bibtex"))
    @Manual{codemetar,
    -  title = {codemetar: Generate CodeMeta Metadata for R Packages},
    +  title = {codemetar: Generate 'CodeMeta' Metadata for R Packages},
       year = {2018},
    -  note = {R package version 0.1.2},
    +  note = {R package version 0.1.4},
     }
    bibitem
    -
    (2018). _codemetar: Generate CodeMeta Metadata for R Packages_. R
    -package version 0.1.2.
    +
    (2018). _codemetar: Generate 'CodeMeta' Metadata for R Packages_.
    +R package version 0.1.4.

    Parsing the ropensci corpus

    diff --git a/docs/articles/index.html b/docs/articles/index.html index 81e3c3ba..a7162b13 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -102,7 +102,7 @@
    diff --git a/docs/authors.html b/docs/authors.html index 0cd87e59..566c7b9c 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • diff --git a/docs/index.html b/docs/index.html index ce02018e..a22b878e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,7 +5,7 @@ -Generate CodeMeta Metadata for R Packages • codemetar +Generate 'CodeMeta' Metadata for R Packages • codemetar @@ -54,7 +54,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -103,9 +103,9 @@

    Example

    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")
    +
    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(".")

    Which creates a file looking like so (first 10 lines; see full codemeta.json here):

    {
       "@context": [
    @@ -149,6 +149,8 @@ 

    Links

    @@ -109,10 +109,18 @@

    Change log All releases

    +
    +

    +codemetar 0.1.4

    +
      +
    • Allow vignettes to gracefully handle network timeout errors that may occur on CRAN’s Windows build server.
    • +
    +

    codemetar 0.1.3

      +
    • CRAN release
    • Switch to http://purl.org based URIs for the JSON-LD Context file instead of a DOI, due to frequent failure of content negotiation on DataCite servers (#34)
    • bugfix UTF-8 characters in CITATION files (#44)
    • bugfix to git URLs
    • @@ -147,6 +155,7 @@

      Contents

      diff --git a/docs/reference/codemeta_validate.html b/docs/reference/codemeta_validate.html index 76230fc1..69a414f0 100644 --- a/docs/reference/codemeta_validate.html +++ b/docs/reference/codemeta_validate.html @@ -77,7 +77,7 @@ Validation in JSON-LD
    • - Parsing Codmeta Data + Parsing Codemeta Data
    diff --git a/docs/reference/codemetar-package.html b/docs/reference/codemetar-package.html index 5115bafe..f9511880 100644 --- a/docs/reference/codemetar-package.html +++ b/docs/reference/codemetar-package.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • diff --git a/docs/reference/create_codemeta.html b/docs/reference/create_codemeta.html index 1eb0f037..93326b28 100644 --- a/docs/reference/create_codemeta.html +++ b/docs/reference/create_codemeta.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -109,7 +109,7 @@

    create_codemeta

    create a codemeta list object in R for further manipulation. Similar -to write_codemeta, but returns an R list object rather +to write_codemeta, but returns an R list object rather than writing directly to a file. See examples.

    diff --git a/docs/reference/crosswalk.html b/docs/reference/crosswalk.html index 9cc49843..8739813c 100644 --- a/docs/reference/crosswalk.html +++ b/docs/reference/crosswalk.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -111,7 +111,7 @@

    crosswalk

    Crosswalk between different metadata fields used by different repositories, registries and archives. For more details see https://codemeta.github.io/crosswalk This function requires an internet connection to obtain the latest crosswalk table. -This function essentially applies the crosswalk table shown by crosswalk_table +This function essentially applies the crosswalk table shown by crosswalk_table to a given JSON metadata record.

    diff --git a/docs/reference/crosswalk_table.html b/docs/reference/crosswalk_table.html index 48cf7bf9..8d530955 100644 --- a/docs/reference/crosswalk_table.html +++ b/docs/reference/crosswalk_table.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • diff --git a/docs/reference/crosswalk_transform.html b/docs/reference/crosswalk_transform.html index 1bb70148..adb5d978 100644 --- a/docs/reference/crosswalk_transform.html +++ b/docs/reference/crosswalk_transform.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • diff --git a/docs/reference/drop_context.html b/docs/reference/drop_context.html index 6821ba1e..ffa4b5a9 100644 --- a/docs/reference/drop_context.html +++ b/docs/reference/drop_context.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • diff --git a/docs/reference/index.html b/docs/reference/index.html index eb72f5ec..16b0798d 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data
  • @@ -106,7 +106,7 @@ diff --git a/docs/reference/write_codemeta.html b/docs/reference/write_codemeta.html index 3c838b89..4ec661c5 100644 --- a/docs/reference/write_codemeta.html +++ b/docs/reference/write_codemeta.html @@ -77,7 +77,7 @@ Validation in JSON-LD
  • - Parsing Codmeta Data + Parsing Codemeta Data