A collection of internal utility functions to validate
individual attributes
within Routes, BirdFlowRoutes, and BirdFlowIntervals, and related
objects. These functions ensure the correctness,
consistency, and validity of attributes used in BirdFlow data structures.
Usage
validate_Routes_route_id(route_id)
validate_Routes_date(date_vector)
validate_Routes_lon(lon_vector)
validate_Routes_lat(lat_vector)
validate_Routes_route_type(route_type_vector)
validate_BirdFlowRoutes_x(x_vector)
validate_BirdFlowRoutes_y(y_vector)
validate_BirdFlowRoutes_i(i_vector)
validate_BirdFlowRoutes_timestep(timestep_vector)
validate_BirdFlowRoutes_date(route_id_vector, date_vector)
validate_BirdFlowRoutes_species(species)
validate_BirdFlowRoutes_metadata(metadata)
validate_BirdFlowRoutes_dates(dates)
validate_BirdFlowIntervals_interval_id(interval_id)Arguments
- route_id
A vector of route IDs (character or numeric). Must not contain missing values.
- date_vector
A vector of dates (
Date,POSIXct, orPOSIXlt). Must not contain missing values; Must not have duplicates within aroute_id(forBirdFlowRoutes; but not forRoutes).- lon_vector, lat_vector
Numeric vectors for longitude and latitude. Must not contain missing values and must be within valid ranges.
- route_type_vector
A character vector of route types. Any character values are accepted; non-standard values produce a warning.
- x_vector, y_vector
Numeric vectors for spatial coordinates. Must not contain missing values.
- i_vector
An integer vector for spatial indices. Must not contain missing values.
- timestep_vector
An integer vector for timesteps, paired with
route_id_vector.- species
A list with species information. Must include
species_code,scientific_name, andcommon_name.- metadata
A list with additional metadata.
- dates
A data frame with date-related information. Must include
interval,date,midpoint,start,end,doy, andweek.
Value
Each function returns TRUE if validation succeeds. If validation
fails, an error is raised with details about the issue.
Details
These functions validate specific attributes or columns in input data frames. They check:
General Attributes:
route_id: Ensures IDs are valid and non-missing.date: Ensures date formats and non-missing values.lonandlat: Ensure longitude and latitude values are within valid ranges.route_type: Warns when non-standard route types are present.
Spatial Attributes (for
BirdFlowRoutes):xandy: Ensure numeric spatial coordinates.i: Ensures valid spatial indices as integers.timestep: Ensures unique timesteps perroute_id.
Additional Attributes:
species: Ensures species data contains required components.geom: Ensures geometry data includes all required fields.dates: Validates date-related data frames, checking required columns.
These functions are intended for internal use and are not exported for user-facing functionality.
Functions Included:
General Validators:
validate_Routes_route_id()validate_Routes_date()validate_Routes_lon(),validate_Routes_lat()validate_Routes_route_type()
BirdFlowRoutesValidators:validate_BirdFlowRoutes_x(),validate_BirdFlowRoutes_y()validate_BirdFlowRoutes_i(),validate_BirdFlowRoutes_timestep(),validate_BirdFlowRoutes_date(),validate_BirdFlowRoutes_species()
BirdFlowIntervalsValidators:validate_BirdFlowIntervals_interval_id()
Dates and Metadata:
validate_BirdFlowRoutes_dates()validate_BirdFlowRoutes_metadata()
