In ropenscilabs/datasauce: Create and manipulate Schema.org Dataset metadata

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)

datasauce

The goal of datasauce is to facilitate creation and manipulation of metadata which uses Google's Structured Data format; essentially JSON-LD formatted files which use https://schema.org/Dataset. Users can check their document interactively using the Structured Data Testing Tool. See Google's Dataset Documentation for more on this approach.

The rOpenSci Project may use datasauce to create and manage metadata about all of the open data sources that can be accessed with rOpenSci packages. This could facilitate discovery of relevant data.

Installation

You can install datasauce from GitHub with:

# install.packages("devtools")
devtools::install_github("ropenscilabs/datasauce")

Getting Started

Concept design stage still. Use ? functions and tab completion to see slots of available objects.

library(datasauce)
me <- Person(givenName = "Carl", familyName = "Boettiger", email = "[e-mail]")
as_jsonld(me)

The main purpose of the package is to take advantage of tab completion and built-in documentation. For instance, typing datasauce::P and hitting tab, we see a list of all possible object types (classes) starting with P. Typing a full class, such as datasauce::Place( and hitting tab, we see a list of possible properties for Place. The manual entry, ?Place, shows the definitions for each of these properties, along with there expected types.

---

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

ropenscilabs/datasauce documentation built on May 17, 2022, 4:25 p.m.