table_save: Save a known location table

View source: R/table_save.R

table_saveR Documentation

Save a known location table

Description

Save a tibble of known locations to the preferred directory.

Usage

table_save(
  locationTbl = NULL,
  collectionName = NULL,
  backup = TRUE,
  outputType = c("rda", "csv")
)

Arguments

locationTbl

Tibble of known locations.

collectionName

Character identifier for this table.

backup

Logical specifying whether to save a backup version of any existing tables sharing collectionName.

outputType

Output format. One of "rda" or "csv".

Details

Backup files are saved with "YYYY-mm-ddTHH:MM:SS"

Value

File path of saved file.

Examples

library(MazamaLocationUtils)

# Set the directory for saving location tables
setLocationDataDir(tempdir())

# Load an example table and check the dimensions
locationTbl <- get(data("wa_monitors_500"))
dim(locationTbl)

# Save it as "table_save_example"
table_save(locationTbl, "table_save_example")

# Add a column and save again
locationTbl %>% 
  table_addColumn("my_column") %>% 
  table_save("table_save_example")
  
# Check the locationDataDir
list.files(getLocationDataDir(), pattern = "table_save_example")


MazamaLocationUtils documentation built on Nov. 2, 2023, 6:16 p.m.