Skip to contents

Reads a CSV file defining coarse stationary periods (stap0) or validates a data.frame, including date parsing, ordering, and overlap checks.

Usage

read_stap(x, required_cols = c("start", "end"))

Arguments

x

a stap data.frame, a CSV path, or a tag id (character scalar). If x is a tag id, the default file path is ./data/stap-label/{id}.csv.

required_cols

character vector of required columns (default: c("start", "end")).

Value

A data.frame containing at least the required columns, sorted by start.

Examples

# From a data.frame
stap_df <- data.frame(
  start = as.POSIXct(c("2020-01-01", "2020-01-03"), tz = "UTC"),
  end = as.POSIXct(c("2020-01-02", "2020-01-04"), tz = "UTC")
)
read_stap(stap_df)
#>        start        end
#> 1 2020-01-01 2020-01-02
#> 2 2020-01-03 2020-01-04

# From a CSV path
# read_stap("./data/stap-label/18LX.csv")