writePreparedData: Persist to disk a prepared data.frame and metadata

View source: R/new-dataset.R

writePreparedDataR Documentation

Persist to disk a prepared data.frame and metadata

Description

Persist to disk a prepared data.frame and metadata

Usage

writePreparedData(data, metadata = attr(data, "metadata"), file)

Arguments

data

a data.frame that meets the Crunch API specification, as returned by prepareDataForCrunch().

metadata

list of Crunch metadata that corresponds to data. Default is the "metadata" attribute of data, as returned by prepareDataForCrunch().

file

character file path, without extension, to write to.

Value

A character vector of length 2: given a value of file="example", it would return c("example.csv.gz", "example.json"). The function, of course, is called for its side effects of writing a gzipped CSV and a JSON file to those locations.


Crunch-io/rcrunch documentation built on April 1, 2024, 1:14 a.m.