climacell_wind: Wind Readings from Climacell

In nikdata/RClimacell: R Wrapper for the 'Climacell' API

Description

This function will make a call to the Climacell API and retrieve wind related variables.

Usage

climacell_wind(
  api_key,
  lat,
  long,
  timestep,
  start_time = NULL,
  end_time = NULL
)

Arguments

api_key	character string representing the private API key. Provided by user or loaded automatically from environment variable (environment variable must be called "CLIMACELL_API").
lat	a numeric value (or a string that can be coerced to numeric) representing the latitude of the location.
long	a numeric value (or a string that can be coerced to numeric) representing the longitude of the location.
timestep	a 'step' value for the time. Choose one of the following valid values: c('1d', '1h', '30m','15m','5m','1m','current').
start_time	the start time of the query. This input must be a character string that can be parsed into a data/time or a date/time value. If the input does not contain a timezone, the value will be assumed to be in UTC. It is recommended that the lubridate::now() function or Sys.time() be used to define the start_time. For this function, the start_time cannot be less than 6 hours from the current time.
end_time	the end time of the query. This input must be a character string that can be parsed into a data/time or a date/time value. If the input does not contain a timezone, the value will be assumed to be in UTC. OPTIONAL if timestep is 'current' or if the user desires to get the maximum results possible (depends on the timestep chosen).

Details

climacell_wind returns a tibble that consists of wind related variables (returned values are in metric units) using the Climacell API. These variables consist of wind speed, wind gust, and wind direction.

Value

a tibble

Examples

## Not run: 
climacell_wind(
  api_key = Sys.getenv('CLIMACELL_API'),
  lat = 0,
  long = 0,
  timestep = 'current')

## End(Not run)

nikdata/RClimacell documentation built on March 26, 2021, 10:43 p.m.