sts_isValid: Test _sts_ object for correct structure

View source: R/utils-sts.R

sts_isValidR Documentation

Test sts object for correct structure

Description

The sts is checked for the presence of core meta and data columns.

Core meta columns include:

  • deviceDeploymentID – unique identifier (see MazmaLocationUtils)

  • deviceID – device identifier

  • locationID – location identifier (see MazmaLocationUtils)

  • locationName – English language name

  • longitude – decimal degrees E

  • latitude – decimal degrees N

  • elevation – elevation of station in m

  • countryCode – ISO 3166-1 alpha-2

  • stateCode – ISO 3166-2 alpha-2

  • timezone – Olson time zone

Core data columns include:

  • datetime – measurement time (UTC)

Usage

sts_isValid(sts = NULL, verbose = FALSE)

Arguments

sts

sts object

verbose

Logical specifying whether to produce detailed warning messages.

Value

TRUE if sts has the correct structure, FALSE otherwise.

Examples

library(MazamaTimeSeries)

sts_isValid(example_sts)


MazamaTimeSeries documentation built on June 8, 2025, 2 p.m.