snapshot_list: List the Available Snapshots

Description Usage Arguments Value

View source: R/snapshot_list.R

Description

This function lists currently available snapshots, assuming a common file pattern and snapshot IDs by date. The current default values are tailored to the Orange County setup.

Usage

1
2
3
4
snapshot_list(start = "2018-04-26", end = "2021-01-01", path = "7z",
  pattern = "^(?=.*Cntywd_)(?!.*Hist)", file_type = ".txt",
  format = "%m%d%y", recursive = FALSE, period = 1,
  file_prefix = "Cntywd_")

Arguments

start

The start date of the first snapshot. Defaults to April 26, 2018.

end

The end date of the last snapshot. Defaults to Jan 1, 2021.

path

Path where all snapshots are stored. Defaults to subfolder 7z.

pattern

Regular expression of the file pattern to find. Defaults to a particular pattern of OCROV files.

file_type

File type. Defaults to .txt.

format

Format of the date in the snapshot file names. Defaults to "%m%d%y".

recursive

Whether to find files recursively. Defaults to FALSE.

period

Period/interval between each snapshot— whether daily, weekly, and so on. Defaults to 1 (equivalent to "day"). Any valid input for base seq.Date by argument is allowed.

file_prefix

File name file_prefix. Defaults to Cntywd_.

Value

A dataframe that contains available snapshots.


sysilviakim/voterdiffR documentation built on June 22, 2020, 6:51 p.m.