R/ds_read_index.R

Defines functions ds_read_index

Documented in ds_read_index

#' ds_read_index
#'
#' reads (json)-index file about all versioned data-objects from specified datastore
#'
#' @param ds path to datastore
#'
#' @return a list containing the following elements
#' \itemize{
#' \item \strong{last_indexed}: timestamp
#' \item \strong{datasets}: the name of the datasets that are versioned
#' \item \strong{info}: a \code{data.frame} containing information about all versioned data-objects
#' }
#' @export
#'
#' @examples
#' ## not yet
ds_read_index <- function(ds) {
  # read json of dataset files
  return(fromJSON(ds_infofile(ds)))
}
bernhard-da/datastore documentation built on Jan. 23, 2019, 5:46 a.m.