| Title: | Interface to the CIMIS Web API |
| Version: | 0.4-1 |
| Description: | Connect to the California Irrigation Management Information System (CIMIS) Web API. See the CIMIS main page https://cimis.water.ca.gov and web API documentation https://et.water.ca.gov for more information. |
| License: | GPL (≥ 3) |
| URL: | https://github.com/mkoohafkan/cimir |
| BugReports: | https://github.com/mkoohafkan/cimir/issues |
| Depends: | R (≥ 3.4) |
| Imports: | curl (≥ 4.3), glue (≥ 1.3), stringr (≥ 1.4), dplyr (≥ 0.8), tidyr (≥ 1.0), jsonlite (≥ 1.6), purrr (≥ 0.3), rlang (≥ 0.4) |
| Encoding: | UTF-8 |
| LazyData: | true |
| Suggests: | knitr (≥ 1.21), rmarkdown (≥ 1.11) |
| VignetteBuilder: | knitr |
| RoxygenNote: | 7.1.1 |
| NeedsCompilation: | no |
| Packaged: | 2021-02-17 22:00:33 UTC; mkoohafk |
| Author: | Michael Koohafkan [aut, cre] |
| Maintainer: | Michael Koohafkan <michael.koohafkan@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2021-02-17 22:40:03 UTC |
cimir: Interface to CIMIS
Description
This package provides an R interface to the California Irrigation Management Information System (CIMIS) Web API. In order to use this package, you will need to create a CIMIS account and request a web services AppKey.
Package options
cimir uses the following options() to configure behavior:
-
cimir.appkey: The CIMIS AppKey to use for queries. -
cimir.timeout: The maximum time to wait for a response from the CIMIS Web API.
Alternatively, the CIMIS App Key can be saved to an environment
variable CIMIS_APPKEY.
Author(s)
Maintainer: Michael Koohafkan michael.koohafkan@gmail.com
See Also
Useful links:
Quick Fix to as_tibble
Description
Handle empty lists when coercing to tibble. See tibble issue 851.
Usage
as_tibble_fix(d)
Arguments
d |
An object to coerce to a tibble. |
Value
a tibble.
Basic Query
Description
Helper function for CIMIS query handling.
Usage
basic_query(url)
Arguments
url |
The query URL. |
Value
The parsed JSON string, as a list.
Bind Records
Description
Bind CIMIS records into a single data frame. This function is used internally.
Usage
bind_records(result)
Arguments
result |
CIMIS query results. |
Value
A data frame.
Defunct functions in package cimir.
Description
The functions listed below were deprecated in the previous
release and are now defunct. Alternative functions with similar
functionality are mentioned. Help pages for defunct functions are
available at help("cimir-defunct").
Usage
get_data(
targets,
start.date,
end.date,
items,
measure.unit = c("E", "M"),
prioritize.SCS = TRUE
)
get_station(station)
get_station_spatial_zipcode(zipcode)
get_station_zipcode(zipcode)
to_datetime(d)
data_items(type = c("Daily", "Hourly"))
get_data
For get_data, use cimis_data.
get_station
For get_station, use cimis_station.
get_station_spatial_zipcode
For get_station_spatial_zipcode, use cimis_spatial_zipcode.
get_station_zipcode
For get_station_zipcode, use cimis_zipcode.
to_datetime
For to_datetime, use cimis_to_datetime.
data_items
For data_items, use cimis_items.
cimir curl handle
Description
Get the handle for curl URL handling in cimir.
Usage
cimir_handle()
Compass Direction To Degrees
Description
Convert the Compass direction labels to degrees.
Usage
cimis_compass_to_degrees(x)
Arguments
x |
A vector of compass directions, i.e. the data item labels "DayWindNnw", "DayWindSse", etc. Recognized directions are North-northeast (NNE), East-northeast (ENE), East-southeast (ESE), South-southeast (SSE), South-southwest (SSW), West-southwest (WSW), West-northwest (WNW), and North-northwest (NNW). |
Value
A numeric vector of degrees corresponding to the middle azimuth of the corresponding compass direction.
See Also
Examples
cimis_compass_to_degrees("day-wind-nne")
cimis_compass_to_degrees(c("SSE", "SSW", "wsw", "Wnw", "nnw"))
Query CIMIS Data
Description
Query CIMIS data using the Web API.
Usage
cimis_data(
targets,
start.date,
end.date,
items,
measure.unit = c("E", "M"),
prioritize.SCS = TRUE
)
Arguments
targets |
geographies or weather stations of interest. This parameter may specify one or many stations, zip codes, coordinates, or street addresses; however, you are not allowed to mix values from different categories. This means the targets parameter must contain only stations, only zip codes, only coordinates, or only street addresses. You will receive an error if you attempt to mix different category types. The formats are accepted:
|
start.date |
Specifies the start date. The data format is
|
end.date |
Specifies the end date. The data format is
|
items |
specifies one or more comma-delimited data elements to
include in your response. See |
measure.unit |
The unit of measure may be either |
prioritize.SCS |
This parameter is relevant only when the
targets parameter contains zip code(s). If |
Value
A tibble object.
Examples
if(is_key_set()) {
cimis_data(targets = 170, start.date = Sys.Date() - 4,
end.date = Sys.Date() - 1)
}
Degrees to Compass Direction
Description
Convert decimal degrees to Compass direction.
Usage
cimis_degrees_to_compass(x)
Arguments
x |
A vector of directions in decimal degrees. |
Details
Degrees are labeled with their corresponding Primary InterCardinal compass direction, following the convention of the CIMIS daily wind data items.
Value
A factor vector of compass directions.
See Also
Examples
cimis_degrees_to_compass(c(30, 83, 120, 140, 190, 240, 300, 330))
cimis_degrees_to_compass(cimis_compass_to_degrees(c("NNE", "ENE",
"ESE", "SSE", "SSW", "WSW", "WNW", "NNW")))
CIMIS Data Flags
Description
List CIMIS data quality control flags.
Usage
cimis_flags(type = c("Severe", "Informative"), period = "Current")
Arguments
type |
The type of data flag, i.e. |
period |
The Time period that data was collected, i.e., "Current" or "Former" (pre-1995). |
Value
a dataframe of data flags.
See Also
CIMIS Data Overview - Quality Control
Examples
cimis_flags()
cimis_flags("Informative")
cimis_flags("Severe", period = "Former")
Format CIMIS Station Location
Description
Format the latitude and longitude of station in Decimal Degrees (DD) or Hour Minutes Seconds (HMS).
Usage
cimis_format_location(d, format = c("DD", "HMS"))
Arguments
d |
A data frame of CIMIS data results. |
format |
The format to use, either Decimal Degrees ( |
Value
The data frame, with a new "Latitude" and "Longitude"
columns replacing the "HmsLatitude" and "HmsLongitude"
columns.
Examples
if(is_key_set()) {
d = cimis_station(170)
cimis_format_location(d, "DD")
cimis_format_location(d, "HMS")
}
CIMIS Data Items
Description
List CIMIS data items.
Usage
cimis_items(type = c("Daily", "Hourly"))
Arguments
type |
The type of data item, i.e. |
Value
a dataframe of data items.
Examples
cimis_items()
Split CIMIS Query
Description
Split a large CIMIS query into multiple smaller queries based on a time interval.
Usage
cimis_split_query(targets, start.date, end.date, items, max.records = 1750L)
Arguments
targets |
geographies or weather stations of interest. This parameter may specify one or many stations, zip codes, coordinates, or street addresses; however, you are not allowed to mix values from different categories. This means the targets parameter must contain only stations, only zip codes, only coordinates, or only street addresses. You will receive an error if you attempt to mix different category types. The formats are accepted:
|
start.date |
Specifies the start date. The data format is
|
end.date |
Specifies the end date. The data format is
|
items |
specifies one or more comma-delimited data elements to
include in your response. See |
max.records |
The maximum number of records returned by a query. The default value is the the maximum data limit allowed by the CIMIS Web API (1,750 records). |
Details
Queries are not split by targets or items, i.e. each
resulting query will include all targets and items.
Value
A data frame with columns "targets", "start.date", "end.date", and "items".
Examples
cimis_split_query(170, "2000-01-01", "2010-12-31", "day-air-tmp-avg")
cimis_split_query(c(149, 170), "2018-01-01", "2018-12-31",
c("day-air-tmp-avg", "hly-air-tmp", "hly-rel-hum"))
Query CIMIS Station Metadata
Description
Query CIMIS station metadata.
Usage
cimis_station(station)
cimis_spatial_zipcode(zipcode)
cimis_zipcode(zipcode)
Arguments
station |
The station ID. If missing, metadata for all stations is returned. |
zipcode |
The (spatial) zip code. If missing, metadata for all stations is returned. |
Value
A tibble object.
Examples
if(is_key_set()) {
cimis_station()
cimis_zipcode()
cimis_spatial_zipcode()
}
To Datetime
Description
Collapse The Date and Hour columns to a single DateTime Column.
Usage
cimis_to_datetime(d)
Arguments
d |
A data frame of CIMIS data results. |
Details
According to the CIMIS Report FAQs, all CIMIS data is based on Pacific Standard Time (PST).
Value
The data frame, with a new "Datetime" column replacing
the "Date" and "Hour" columns.
Examples
if(is_key_set()) {
d = cimis_data(targets = 170, start.date = Sys.Date() - 4,
end.date = Sys.Date() - 1, items = "hly-air-tmp")
cimis_to_datetime(d)
}
dataitems
Description
A tibble of data items and their names, classes, and providers.
Usage
dataitems
Format
An object of class data.frame with 43 rows and 4 columns.
Record to Data Frame
Description
Convert a single record, containing one or more data items, to a to a single data frame.
Usage
record_to_df(record)
Arguments
record |
A single CIMIS record, in list format. |
Value
A data frame. The column "Item" identifies the data item.
Specify CIMIS API key
Description
Enter your CIMIS AppKey for web API data access.
Usage
set_key(key = NULL)
remove_key()
is_key_set()
Arguments
key |
A CIMIS AppKey. |
Examples
## Not run:
set_key("YOUR-APP-KEY")
is_key_set()
remove_key()
## End(Not run)