Skip to contents

API Request Constructors

Constructor functions to build a Cal-Adapt API request object

ca_loc_aoipreset()
Adds a preset location to a Cal-Adapt API request
ca_loc_pt()
Add point location(s) to a Cal-Adapt API request
ca_loc_sf()
Use a sf data frame as the location for a Cal-Adapt API request
ca_cvar()
Add climate variable(s) to a Cal-Adapt API request
ca_gcm()
Adds GCM(s) to a Cal-Adapt API request
ca_period()
Assign temporal aggregation period to a Cal-Adapt API call
ca_scenario()
Add emission scenario(s) to a Cal-Adapt API request
ca_slug()
Adds slug(s) to a Cal-Adapt API call
ca_years()
Adds the start and end year to a Cal-Adapt API call
ca_livneh()
Use Livneh data in a Cal-Adapt API call
ca_dates()
Adds a start and end date of a Cal-Adapt API call
ca_options()
Add processing options to a Cal-Adapt API call
ca_apireq()
Creates a new API request object
ca_example_apireq()
Sample API requests

Fetching Data

Functions that fetch climate data using the Cal-Adapt API

ca_preflight()
Run checks on an API request object
ca_getvals_tbl()
Get values from an API request object as a tibble
ca_getvals_db()
Write values from an API request to a local database
ca_getrst_stars()
Get cropped rasters
ca_baseurl
Cal-Adapt base URL

Finding and Specifying Cal-Adapt Datasets

Constants and functions to help you identify and specify datasets when constructing an API request object

cvars
Climate variables
gcms
Global climate models
periods
Temporal aggregation periods
scenarios
Scenarios
ca_locagrid_geom()
Get the LOCA grid cells as a sf object

Using the Cal-Adapt data catalog

Use a local copy of the Cal-Adapt catalog to find the data you’re looking for

ca_catalog_rs()
Get the Cal-Adapt raster series data catalog
ca_catalog_fetch()
Fetch a new copy of the Cal-Adapt raster series catalog
ca_catalog_search()
Search the Cal-Adapt raster series data catalog

Working with Area-of-Interest Presets

Constants and functions to help you specify a preset Area-of-Interest & get geoms

aoipreset_types aoipreset_idflds aoipreset_idval
Area-of-interest presets
ca_aoipreset_geom()
Get the geometry of an AOI Preset area
bbox_resize()
Resize a bounding box object

Managing SQLite databases

Working with local SQLite databases

ca_db_read()
Load a Cal-Adapt SQLite database into R
ca_db_info()
View properties of a Cal-Adapt SQLlite database
ca_db_indices()
Add or delete indices

Managing Rasters

Downloading and working with climate data as rasters

ca_biggeom_blocks()
Split a large geom into blocks small enough to ask the API for rasters
ca_stars_read()
Read tif files from disk
ca_stars_index()
Create an index for a list of stars rasters
ca_stars_6d()
Create a six-dimensional stars object for modeled climate data
ca_stars_mosaic()
Mosaic stars objects into a seamless array for large areas

Package Options

Manage package settings

ca_settings()
Manage package settings
ca_getcache() ca_setcache()
Manage cache directory

Printing and plotting

Print and plot objects

format(<ca_apireq>)
Format a ca_apireq object
print(<ca_apireq>)
Print a ca_apireq object
plot(<ca_apireq>)
Plot a ca_apireq object
format(<ca_db_info>)
Format a ca_db_info object for printing at the console
print(<ca_db_info>)
Print a ca_db_info object