write_mudata: Read/Write mudata objects

In mudata2: Interchange Tools for Multi-Parameter Spatiotemporal Data

Read/Write mudata objects

Description

These functions will read and write mudata objects to disk using a directory (which contains one .csv file for each table in the object), a ZIP archive (which is a zipped version of the directory format), or a JSON file. The base read/write functions attempt to guess which of these types to use based on the file extension: use the specific read/write function to avoid this.

Usage

write_mudata(md, filename, ...)

read_mudata(filename, ...)

write_mudata_zip(
  md,
  filename,
  overwrite = FALSE,
  validate = TRUE,
  update_columns = TRUE,
  ...
)

read_mudata_zip(filename, validate = TRUE, ...)

write_mudata_dir(
  md,
  filename,
  overwrite = FALSE,
  validate = TRUE,
  update_columns = TRUE,
  ...
)

read_mudata_dir(filename, validate = TRUE, ...)

write_mudata_json(
  md,
  filename,
  overwrite = FALSE,
  validate = TRUE,
  update_columns = TRUE,
  pretty = TRUE,
  ...
)

to_mudata_json(md, validate = TRUE, update_columns = TRUE, pretty = FALSE, ...)

read_mudata_json(filename, validate = TRUE, ...)

from_mudata_json(txt, validate = TRUE, ...)

Arguments

md	A mudata object
filename	File to read/write (can also be a directory)
...	Passed to read/write functions
overwrite	Pass TRUE to overwrite if the file/directory already exists.
validate	Flag to validate mudata object after read or before write
update_columns	Update the columns table "type" column to reflect the internal R types of columns (reccommended).
pretty	Produce pretty or minified JSON output
txt	JSON text from which to read a mudata object.

Details

These functions are designed to make sure that the read/write operations are as lossless as possible. Some exceptions to this are if date/time columns are not in UTC (in which case they will be converted to UTC before writing), and if table names have characters that are not filesystem safe (allowed characters are [A-Za-z0-9_.-] and others will be stripped).

Examples

# read/write to directory
outfile <- tempfile(fileext = ".mudata")
write_mudata(kentvillegreenwood, outfile)
md <- read_mudata(outfile)
unlink(outfile)

# read/write to JSON
outfile <- tempfile(fileext = ".json")
write_mudata(kentvillegreenwood, outfile)
md <- read_mudata(outfile)
unlink(outfile)

mudata2 documentation built on Jan. 22, 2023, 1:48 a.m.