sync_software_metadata: Synchronize software with source metadata

Description Usage Arguments Details Value Examples

View source: R/sync_software_metadata.R

Description

Currently supports CRAN and GitHub.

Usage

1

Arguments

name

(character) Software name(s). Use name = "all_imcr_software" to update all IMCR software metadata.

Details

This function looks for two URLs listed in the intial, manually entered, OntoSoft metadata record. These are: (1.) The official archive in which the software is published (e.g. CRAN (https://cran.r-project.org/web/packages/codemetar/index.html)) listed under the OntoSoft property hasProjectWebsite (i.e. in the field "Is there a project website for the software?"), and (2.) The official location of where the software is being developmed/maintained (e.g. GitHub (https://github.com/ropensci/antiword)) listed under the OntoSoft object property hasActiveDevelopment (i.e. in the field "How is the software being developed or maintained?"). Software metadata is extracted from these two sources and combinded through the codemeta crosswalk then added to the OntoSoft metadata. Information not supported by codemeta is supplied directly to the OntoSoft metadata.

Value

(list) Updated software JSON for the specified name and added to the imcr_json object in the global environment. (logical) Updated imcr_json_mod_index object in the global environment, which indicates the specified name has been modified and is used by put_software().

Examples

1
2
3
4
5
6
7
8
## Not run: 
get_imcr_json()
sync_software_metadata("arrow")
login()
put_software()
logout()

## End(Not run)

IMCR-Hackathon/toolkit documentation built on Oct. 30, 2019, 7:14 p.m.