README.md

In scoyoc/climateAnalyzeR: Import Data from ClimateAnalyzer.org into R

climateAnalyzeR

This package imports data from ClimateAnalyzer.org into R. Currently annual, monthly, daily weather data, temperatures above/below a specified temperature, and water balance models for Co-op stations are available.

This R package can also produce brief climate reports using temperature and precipitation data from Co-op stations using RMarkdown. Currently water year (Oct-Sep) and calendar year (Jan-Dec) reports are available. The plan is to include water balance summaries to the RMarkdown scripts in the future.

Version: 0.9.2

Depends: R (>= 4.0)

Imports: cowplot, dplyr, ggplot2, glue, ggmap, grid, gridExtra, knitr, janitor, lubridate, readr, rmarkdown, shadowtext, stats, stringr, tidyr, tibble, utils, XML

Suggests: tidyverse

Author: Matthew Van Scoyoc

Contributors: Kara Raymond

Maintainer: Matthew Van Scoyoc

Issues: https://github.com/scoyoc/climateAnalyzeR/issues

License: MIT + file LICENSE

URL: https://github.com/scoyoc/climateAnalyzeR

Documentation: Just the man pages for now. A vignette is planned for development.

Installation

Perhaps someday you will be able to install this package from CRAN, but for now you can install it form GitHub.

devtools::install_github("scoyoc/climateAnalyzeR")

Examples

Below are examples of functions that import data from ClimateAnalyzer.org.

#-- Annual data
# Import annual temperature and precipitation data and remove columns of missing
#     values.
import_data("annual_wx", "canyonlands_theneck", 1980, 2020, 
            remove_missing = FALSE)

# Import annual temperature and precipitation data and convert values to metric
import_data("annual_wx", "canyonlands_theneck", 1980, 2020, convert = TRUE)

#-- Daily data
# Import daily temperature and precipitation data
import_data("daily_wx", "hans_flat_rs", 2010, 2020)

#-- Monthly data
# Import monthly precipitation and temperature data for the month of June
import_data("monthly_wx", 'canyonlands_theneedle', 2000, 2010, month = 6)

#-- Monthly departures
# Import departures for the month of July
import_data("departure", 'natural_bridges_nm', 2000, 2010, month = 7)

#-- Water balance data
# Import monthly water balance data using the Hamon model with soil water
#     capacity set to 100.
import_data("water_balance", "arches", 2015, 2020, table_type = "monthly",
            soil_water = 100, pet_type = "hamon", forgiving = "very")

#-- Number of days per year above/below user set temperature
# Import the number of days per year that are below a user set minimum 
#     temperature and above a user set maximum temperatures.
import_below_above_temp(station_id = "tumacacori", start_year = 1991,
                        end_year = 2020, tmin_temp = 20, tmax_temp = 100,
                        station_type = "GHCN", year = "year")

#-- Count of days under the 5th percentile and above the 95th percentile
# Import the number of days per year that temperatures were below the 5th
#     percentile and above the 95th percentile.
import_extreme_temp(station_id = "tumacacori", start_year = 1991, 
                    end_year = 2020, station_type = "GHCN", year = "year")

Below are examples that produce PDF reports.

library(climateAnalyzeR)

# Current water year summary for Arches National Park using the default station 
# name on ClimateAnalyzer.org
renderSummary(my_report = "water_year", station_id = "arches")

# Calendar year report for Island in the Sky for 2018 and changing the name used 
# in the report.
renderSummary(my_report = "calendar_year", station_id = "canyonlands_theneck", 
              station_name = "Island in the Sky, Canyonlands National Park", 
              my_year = 2018)

scoyoc/climateAnalyzeR documentation built on April 19, 2023, 9:57 p.m.