R/write_jsonld.R

In dataspice: Create Lightweight Schema.org Descriptions of Data

#' Convert a list object to JSON-LD
#'
#' @param x the object to be encoded.
#' @param context JSON-LD context; "http://schema.org".
#' @param pretty Whether or not to prettify output. See
#'   \code{\link[jsonlite]{toJSON}}.
#' @param auto_unbox Whether or not to automatically unbox output. See
#'   \code{\link[jsonlite]{toJSON}}.
#' @param ... Other arguments to be passed to
#'   \code{\link[jsonlite]{toJSON}}.
as_jsonld <-  function(x,
                       context = "http://schema.org",
                       pretty = TRUE,
                       auto_unbox = TRUE,
                       ...) {

  out <- c(setNames(context, "@context"), x)

  jsonlite::toJSON(out,
                   pretty = pretty,
                   auto_unbox = auto_unbox,
                   ...)

}


#' Write a list out as object to JSON-LD
#'
#' @param context JSON-LD context; "http://schema.org"
#' @inheritParams jsonlite::write_json
#' @inheritParams jsonlite::toJSON
#' @importFrom stats setNames
#'
#'
write_jsonld <-  function(x, path, context = "http://schema.org",
                          pretty = TRUE, auto_unbox = TRUE, ...) {

  out <- c(setNames(context, "@context"), x)
  jsonlite::write_json(out,
                       path = path,
                       pretty = pretty,
                       auto_unbox = auto_unbox,
                       ...)
}