Access Data from the Oregon State Prism Climate Project

Allows users to access the Oregon State Prism climate data. Using the web service API data can easily downloaded in bulk and loaded into R for spatial analysis. Some user friendly visualizations are also provided.


CRAN_Status_Badge BuildStatus Buildstatus codecov.io

This package allows users to access and visualize data from the Oregon State PRISM project. Data is all in the form of gridded rasters for the continental US at 3 different scales: daily, monthly and 30 year normals. Please see their webpage for a full description of the data products, or see their overview.

Quickstart

prism is available on CRAN:

install.packages("prism")

Or the development version can be installed from GitHub with devtools:

# install.packages("devtools")
library(devtools)
install_github(repo = "prism", username = "ropensci")
library(prism)

Downloading data

Data is available in 3 different forms as mentioned above. Each one has it’s own function to download data. While each data type has slightly different temporal parameters, the type options are always the same. Keep in mind these are modeled parameters, not measured. Please see the full description for how they are calculated.

Parameter name Descrption
tmean Mean temperature
tmax Maximum temperature
tmin Minimum temperature
ppt Total precipitation (Rain and snow)
vpdmin Daily minimum vapor pressure deficit [averaged over all days in the month - normal data only]
vpdmax Daily maximum vapor pressure deficit [averaged over all days in the month - normal data only]

Normal data

Normals are based on the years 1981 - 2010, and can be downloaded in two resolutions, 4km and 800m, and a resolution must be specified. Normals can also be downloaded for a given month, vector of months, or an average for all 30 years.

library(prism)
options(prism.path = "~/prismtmp")
get_prism_normals(type="tmean",resolution = "4km",mon = 1:6, keepZip=F)

The first thing to note is that you’ll need to set a local location to work with this data. Second is the option keepZip. If this is TRUE the zip file will remain on your machine, otherwise it will be automatically deleted.

You can also view all the data you have downloaded with a simple command ls_prism_data(). By default this just gives a list of file names. All the internal functions in the package work off of this simple list of files.

## Truncated to keep file list short
ls_prism_data()[1:10,]
#>  [1] "PRISM_ppt_stable_4kmD2_20000101_bil"  
#>  [2] "PRISM_tmean_30yr_normal_4kmM2_01_bil" 
#>  [3] "PRISM_tmean_30yr_normal_4kmM2_02_bil" 
#>  [4] "PRISM_tmean_30yr_normal_4kmM2_03_bil" 
#>  [5] "PRISM_tmean_30yr_normal_4kmM2_04_bil" 
#>  [6] "PRISM_tmean_30yr_normal_4kmM2_05_bil" 
#>  [7] "PRISM_tmean_30yr_normal_4kmM2_06_bil" 
#>  [8] "PRISM_tmean_stable_4kmD1_20130601_bil"
#>  [9] "PRISM_tmean_stable_4kmD1_20130602_bil"
#> [10] "PRISM_tmean_stable_4kmD1_20130603_bil"

While internal plotting functions use this, other files may want an absolute path (e.g. the raster package), there’s a parameter absPath that conventiently returns the absolute path. Alternatively you may want to see what the normal name for the product is (not the file name), and that parameter is name.

ls_prism_data(absPath = TRUE)[1:10,]
#>                                    files
#> 1    PRISM_ppt_stable_4kmD2_20000101_bil
#> 2   PRISM_tmean_30yr_normal_4kmM2_01_bil
#> 3   PRISM_tmean_30yr_normal_4kmM2_02_bil
#> 4   PRISM_tmean_30yr_normal_4kmM2_03_bil
#> 5   PRISM_tmean_30yr_normal_4kmM2_04_bil
#> 6   PRISM_tmean_30yr_normal_4kmM2_05_bil
#> 7   PRISM_tmean_30yr_normal_4kmM2_06_bil
#> 8  PRISM_tmean_stable_4kmD1_20130601_bil
#> 9  PRISM_tmean_stable_4kmD1_20130602_bil
#> 10 PRISM_tmean_stable_4kmD1_20130603_bil
#>                                                                                      abs_path
#> 1      ~/prismtmp/PRISM_ppt_stable_4kmD2_20000101_bil/PRISM_ppt_stable_4kmD2_20000101_bil.bil
#> 2    ~/prismtmp/PRISM_tmean_30yr_normal_4kmM2_01_bil/PRISM_tmean_30yr_normal_4kmM2_01_bil.bil
#> 3    ~/prismtmp/PRISM_tmean_30yr_normal_4kmM2_02_bil/PRISM_tmean_30yr_normal_4kmM2_02_bil.bil
#> 4    ~/prismtmp/PRISM_tmean_30yr_normal_4kmM2_03_bil/PRISM_tmean_30yr_normal_4kmM2_03_bil.bil
#> 5    ~/prismtmp/PRISM_tmean_30yr_normal_4kmM2_04_bil/PRISM_tmean_30yr_normal_4kmM2_04_bil.bil
#> 6    ~/prismtmp/PRISM_tmean_30yr_normal_4kmM2_05_bil/PRISM_tmean_30yr_normal_4kmM2_05_bil.bil
#> 7    ~/prismtmp/PRISM_tmean_30yr_normal_4kmM2_06_bil/PRISM_tmean_30yr_normal_4kmM2_06_bil.bil
#> 8  ~/prismtmp/PRISM_tmean_stable_4kmD1_20130601_bil/PRISM_tmean_stable_4kmD1_20130601_bil.bil
#> 9  ~/prismtmp/PRISM_tmean_stable_4kmD1_20130602_bil/PRISM_tmean_stable_4kmD1_20130602_bil.bil
#> 10 ~/prismtmp/PRISM_tmean_stable_4kmD1_20130603_bil/PRISM_tmean_stable_4kmD1_20130603_bil.bil
 
ls_prism_data(name = TRUE)[1:10,]
#>                                    files
#> 1    PRISM_ppt_stable_4kmD2_20000101_bil
#> 2   PRISM_tmean_30yr_normal_4kmM2_01_bil
#> 3   PRISM_tmean_30yr_normal_4kmM2_02_bil
#> 4   PRISM_tmean_30yr_normal_4kmM2_03_bil
#> 5   PRISM_tmean_30yr_normal_4kmM2_04_bil
#> 6   PRISM_tmean_30yr_normal_4kmM2_05_bil
#> 7   PRISM_tmean_30yr_normal_4kmM2_06_bil
#> 8  PRISM_tmean_stable_4kmD1_20130601_bil
#> 9  PRISM_tmean_stable_4kmD1_20130602_bil
#> 10 PRISM_tmean_stable_4kmD1_20130603_bil
#>                                               product_name
#> 1             Jan 01 2000 - 4km resolution - Precipitation
#> 2  Jan 30-year normals - 4km resolution - Mean temperature
#> 3  Feb 30-year normals - 4km resolution - Mean temperature
#> 4  Mar 30-year normals - 4km resolution - Mean temperature
#> 5  Apr 30-year normals - 4km resolution - Mean temperature
#> 6  May 30-year normals - 4km resolution - Mean temperature
#> 7  Jun 30-year normals - 4km resolution - Mean temperature
#> 8          Jun 01 2013 - 4km resolution - Mean temperature
#> 9          Jun 02 2013 - 4km resolution - Mean temperature
#> 10         Jun 03 2013 - 4km resolution - Mean temperature

You can easily make a quick plot of your data to using the output of ls_prism_data()

prism_image(ls_prism_data()[1,1])

Monthly and Daily Data

Monthly and daily data is also easily accessible. Below we’ll get January data for the years 1990 to 2000. We an also grab data from June 1 to June 14 2013.

get_prism_monthlys(type="tmean", year = 1990:2000, mon = 1, keepZip=F)
get_prism_dailys(type="tmean", minDate = "2013-06-01", maxDate = "2013-06-14", keepZip=F)

Note that for daily data you need to give a well formed date string in the form of “YYYY-MM-DD”

You can also visualize a single point across a set of rasters. This procedure will take a set of rasters, create a stack, extract data at a point, and then create a ggplot2 object.

Let’s get make a plot of January temperatures is Boulder between 1982 and 2014. First we’ll grab all the data from the US, and then give our function a point to get data from. The point must be a vector in the form of longitude, latitude.

library(ggplot2)
boulder <- c(-105.2797,40.0176)
## Get data.
get_prism_monthlys(type="tmean", year = 1982:2014, mon = 1, keepZip=F)
## We'll use regular expressions to grep through the list and get data only from the month of January
to_slice <- grep("_[0-9]{4}[0][1]",ls_prism_data()[,1],value=T)
to_slice = grep("tmean",to_slice, value = T)
p <- prism_slice(boulder,to_slice)
p + stat_smooth(method="lm",se=F) + theme_bw() + 
ggtitle("Average January temperature in Boulder, CO 1982-2014")

Lastly it’s easy to just load up the prism data with the raster package. This time what we’ll look at January temperature anomalies. To do this we’ll examine the difference between January 2013 and the 30 year normals for January. Conveniently, we’ve already downloaded both of these files. We just need to grab them out of our list.

library(raster)
#> Loading required package: sp
### I got these just by looking at the list output
jnorm <- ls_prism_data(absPath=T)[1,2]
j2013 <- ls_prism_data(absPath=T)[52,2]
## See that the full path is returned
jnorm
#> [1] "~/prismtmp/PRISM_ppt_stable_4kmD2_20000101_bil/PRISM_ppt_stable_4kmD2_20000101_bil.bil"
## Now we'll load the rasters.
jnorm_rast <- raster(jnorm)
j2013_rast <- raster(j2013)
## Now we can do simple subtraction to get the anomaly by subtracting 2014 from the 30 year normal map
anomCalc <- function(x, y) {
  return(x - y)
  }
 
anom_rast <- overlay(j2013_rast,jnorm_rast,fun = anomCalc)
 
plot(anom_rast)

The plot shows that January 2013 was warmer than the average over the last 30 years. It also shows how easy it is to use the raster library to work with prism data. The package provides a simple framework to work with a large number of rasters that you can easily download and vizualize or use with other data sets.

Javascript maps

The leaflet package allows you to easily make javascript maps using the leaflet mapping framework using prism data. These can easily be hosted on websites like Rpubs or your own site. Here is a simple example of plotting the 30 year normal for annual temperature.

library(leaflet)
library(raster)
library(prism)
 
## Set default path for raster files
options(prism.path = "~/prismtmp")
get_prism_normals(type="tmean",resolution = "4km",annual =T, keepZip=F)
 
 
## Grab the data, ls_prism_data(absPath=T) will show you all the data you've downloaded
norm <- grep("tmean_30yr_normal_4kmM2_annual",ls_prism_data(absPath=T)[,2],value=T)
rast <- raster(norm)
 
 
## Create color pallette and plot
pal <- colorNumeric(c("#0000FF", "#FFFF00", "#FF0000"), values(rast),
                    na.color = "transparent")
 
leaflet() %>% addTiles(urlTemplate = 'http://server.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer/tile/{z}/{y}/{x}') %>% 
  addRasterImage(rast,colors = pal,opacity=.65) %>% addLegend(pal = pal, values = values(rast),
                                                              title = "Deg C")

News

prism 0.1.0

Minor changes

  • New functions
    • del_early_prov() searches the download folder for duplicated PRISM data and keeps only the newest version.
    • get_prism_station_md() extracts metadata from daily PRISM data.
  • get_prism_dailys () gains a check parameter that allows the user to specify how prism files are checked.

Bug fixes

  • get_prism_monthlys() can now download 1981 data. (@sdtaylor #59, #63)
  • get_prism_annual() can now download pre 1981 data by itself. (@rabutler #64)
  • get_prism_dailys() now correctly sets the progress bar.
  • fixed bug in gen_dates() so that get_prism_dailys() works with only the dates parameter specified. (@rabutler #66)

Under the hood

  • added internal gen_dates() function for determining the specified dates (either from minDate and maxDate. or dates) used by the get_prism_*() functions.
  • added tests for gen_dates() .

prism 0.0.7

Changes

  • Changed aquisition method to use prism webservice. Prior to this change the FTP aquisition method often caused the server to time out when download request volume became too high.

  • Changed method of metadata extraction. Originally we parsed XML metadata to get inforamtion about raster files. However the XML for historical data is particularly sparse. The new method relies on parsing file names instead. While more universal, it may be less stable

Bug fixes

  • Fixed FTP time out error by switching to webservice

  • Fixed prism_stack by adjusting to new metadata extraction method

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("prism")

0.1.0 by Alan Butler, 7 months ago


http://github.com/ropensci/prism


Report a bug at http://github.com/ropensci/prism/issues


Browse source code at https://github.com/cran/prism


Authors: Hart Edmund [aut, ccp] , Kendon Bell [aut] , Alan Butler [ctb, cre]


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports ggplot2, lubridate, raster, httr, dplyr, stringr, magrittr, purrr, readr, utils

Suggests covr, knitr, testthat


See at CRAN