Download and Process 'ERA5', IMD, 'HadEX3' and 'CRU TS' Data

Documentation for package ‘varunayan’ version 0.4.0

Help Pages

-- A --

aggregate_by_frequency	Aggregate data by temporal frequency
aggregate_imd_by_frequency	Aggregate IMD data by temporal frequency
aggregate_to_polygons	Aggregate gridded data to polygon regions
anomaly	Departure from the mean over a baseline period

-- C --

cache_stats	Get cache statistics
calc_heat_indices	Calculate all heat stress indices
categorize_variables	Sort variables by aggregation method
CheckSystemReadiness	Make sure that the system is ready for varunayan operations
check_grid_coverage	Calculate the grid coverage statistics for polygons
check_system_readiness	Make sure that the system is ready for varunayan operations
cleanup_temp_files	Delete temporary files that match a pattern
ClearCache	Clear cache
clear_cache	Clear cache
clear_timings	Clear all time data
combine_netcdf_files	Combine NetCDF files into one data.frame
compare	Agreement statistics between two columns
compare_grids	Compare two or more grids
convert_to_geojson	Convert data to GeoJSON format
create_geojson_from_bbox	Create GeoJSON from bounding box coordinates
create_temporal_chunks	Divide large date ranges into temporal chunks
create_temp_geojson_file	Create temporary GeoJSON file
cross_correlation	Cross-correlation of two series
CRUTSBbox	Download CRU TS climate data for a bounding box
CRUTSGeojson	Download CRU TS climate data for a GeoJSON region
cru_ts_bbox	Download CRU TS climate data for a bounding box
cru_ts_geojson	Download CRU TS climate data for a GeoJSON region

-- D --

DescribeVariables	Describe ERA5 variables in detail
describe_variables	Describe ERA5 variables in detail
dewpoint_from_relative_humidity	Calculate dewpoint from temperature and relative humidity
download_era5_pressure	Download ERA5 pressure-level data with ecmwfr
download_era5_single	Download ERA5 single-level data with ecmwfr
download_imd_rainfall	Download IMD gridded rainfall data
download_imd_temperature	Download IMD gridded temperature data

-- E --

ensure_output_dir	Create the output directory if it does not exist
ERA5ifyBbox	Download and process ERA5 data for a bounding box
ERA5ifyGeojson	PascalCase Aliases
ERA5ifyPoint	Download and process ERA5 data for a point location
era5ify_bbox	Download and process ERA5 data for a bounding box
era5ify_geojson	PascalCase Aliases
era5ify_point	Download and process ERA5 data for a point location
excess_heat_factor	Excess Heat Factor
exclude_cols	Columns to exclude from aggregation
exposure_indicators	Heat exposure indicators
extract_point_data	Extract data for a specified point location (nearest neighbor)

-- F --

filter_dataframe_by_geojson	Filter data.frame by GeoJSON polygon
filter_imd_by_bbox	Filter IMD data by spatial boundaries
filter_imd_by_geojson	Filter IMD data by GeoJSON polygon
filter_netcdf_by_bbox	Filter NetCDF data by spatial boundaries (bounding box)
filter_netcdf_by_geojson	Filter NetCDF data by GeoJSON polygon
format_date_range	Format date range for CDS API requests
format_pressure_levels	Convert pressure levels to the character format necessary for the CDS API

-- G --

GetAvailablePressureLevels	Get the standard pressure levels that are available in ERA5
GetCacheDir	Get cache directory path
GetERA5CountryTemperature	Get ERA5 temperature data for a country
GetERA5DailyClimate	Download daily ERA5 climate data
GetERA5DailyHeatData	Download ERA5 data and calculate heat stress indices
GetERA5DailyHeatIndexData	Download ERA5 data and calculate heat stress indices
GetERA5DailyHumidity	Download daily ERA5 humidity data
GetERA5DailyTemperature	Download daily ERA5 temperature data
GetERA5DailyWetBulb	Download daily ERA5 wet bulb temperature data
GetERA5DailyWind	Download daily ERA5 wind data
GetERA5MonthlyHeatData	Get monthly ERA5 heat stress index data
GetERA5MonthlyHeatIndexData	Get monthly ERA5 heat stress index data
GetPackageInfo	Get package version information
get_available_datasets	Get available dataset types
get_available_pressure_levels	Get the standard pressure levels that are available in ERA5
get_bbox_from_sf	Get bounding box from sf object
get_cache_dir	Get cache directory path
get_cds_credentials	Get CDS API credentials from different sources
get_era5_country_temperature	Get ERA5 temperature data for a country
get_era5_daily_climate	Download daily ERA5 climate data
get_era5_daily_heat_data	Download ERA5 data and calculate heat stress indices
get_era5_daily_heat_index_data	Download ERA5 data and calculate heat stress indices
get_era5_daily_humidity	Download daily ERA5 humidity data
get_era5_daily_temperature	Download daily ERA5 temperature data
get_era5_daily_wet_bulb	Download daily ERA5 wet bulb temperature data
get_era5_daily_wind	Download daily ERA5 wind data
get_era5_monthly_heat_data	Get monthly ERA5 heat stress index data
get_era5_monthly_heat_index_data	Get monthly ERA5 heat stress index data
get_imd_grid_specs	Get IMD grid specifications
get_package_info	Get package version information
get_pressure_level_variables	Get the dataset of pressure-level variables
get_pressure_level_variable_names	Get all valid pressure-level variable names
get_single_level_variables	Get the dataset of single-level variables
get_single_level_variable_names	Get all valid single-level variable names
get_time_values	Get time values for a frequency
get_timings	Get all recorded time measurements

-- H --

HadEX3Bbox	Download HadEX3 data on climate extremes for a bounding box
HadEX3Geojson	Download HadEX3 data on climate extremes for a GeoJSON region
hadex3_bbox	Download HadEX3 data on climate extremes for a bounding box
hadex3_geojson	Download HadEX3 data on climate extremes for a GeoJSON region
heatwave_days	Heatwave days
heat_index	Calculate heat index (apparent temperature)
heat_index_from_dewpoint	Calculate heat index from dewpoint
heat_index_risk_category	Heat index risk categories
humidex	Calculate humidex (Canadian heat index)

-- I --

IMDExposureBbox	IMD heat exposure indicators for a bounding box
IMDRainfallBbox	Download and process IMD rainfall data for a bounding box
IMDRainfallGeojson	Download and process IMD rainfall data for a GeoJSON region
IMDRainfallPoint	Download and process IMD rainfall for a single point (nearest grid cell)
IMDStations	IMD weather stations with coordinates
IMDTemperatureBbox	Download and process IMD temperature data for a bounding box
IMDTemperatureGeojson	Download and process IMD temperature data for a GeoJSON region
imd_exposure_bbox	IMD heat exposure indicators for a bounding box
imd_rainfall_bbox	Download and process IMD rainfall data for a bounding box
imd_rainfall_geojson	Download and process IMD rainfall data for a GeoJSON region
imd_rainfall_point	Download and process IMD rainfall for a single point (nearest grid cell)
imd_stations	IMD weather stations with coordinates
imd_temperature_bbox	Download and process IMD temperature data for a bounding box
imd_temperature_by_region	Download IMD temperature aggregated for each GeoJSON feature (region x time)
imd_temperature_geojson	Download and process IMD temperature data for a GeoJSON region
imd_terrain	IMD heatwave terrain class of a location
india_elevation	Elevation of locations in India
is_max_var	Find if a variable uses maximum aggregation
is_min_var	Find if a variable uses minimum aggregation
is_rate_var	Find if a variable is a rate variable
is_sum_var	Find if a variable uses sum aggregation
is_valid_geojson	Find if data is valid GeoJSON

-- L --

ListAvailableVariables	List all available variables for a dataset type
ListCRUTSVariables	Variable data dictionary for CRU TS
ListHadEX3Indices	List the available HadEX3 ETCCDI indices
list_available_variables	List all available variables for a dataset type
list_cache	List cached files
list_cru_ts_variables	Variable data dictionary for CRU TS
list_hadex3_indices	List the available HadEX3 ETCCDI indices
list_imd_datasets	List available IMD datasets
load_india_boundaries	Load India state or district boundaries

-- M --

max_vars	Variables for maximum aggregation
mean_radiant_temperature	Estimate mean radiant temperature
min_vars	Variables for minimum aggregation

-- N --

ndbi	Normalized Difference Built-up Index
ndvi	Normalized Difference Vegetation Index

-- P --

parse_date_flexible	Parse a date string in different formats
peak_month	Month of the largest long-term mean
plot_bars	Bar chart coloured by value
plot_ccf	Stem plot of a cross-correlation
plot_dual_axis	Two series on a left and a right axis
plot_heatmap	Heat map of a matrix or of a long data frame
plot_map	Map one or more columns of gridded or polygon data
plot_scatter	Scatter plot with the 1:1 line, r and bias
plot_series	Line plot, one line per group
PopulateSampleCache	Fill the cache with sample IMD data
populate_sample_cache	Fill the cache with sample IMD data
print_timing_summary	Print a summary of the time data
process_imd_files	Process multiple IMD files
process_netcdf_to_dataframe	Extract data from a NetCDF file into a data.frame

-- R --

rate_vars	Rate variables to average
read_cdsapirc	Read CDS API credentials from ~/.cdsapirc file
read_imd_rainfall	Read IMD NetCDF rainfall file
read_imd_temperature	Read IMD binary temperature file
regrid	Average onto a coarser regular grid
relative_humidity_from_dewpoint	Calculate relative humidity from temperature and dewpoint

-- S --

SearchVariable	Search for ERA5 variables by keyword
search_variable	Search for ERA5 variables by keyword
seasonal_cycle	Mean for each calendar month
seasonal_stat	Seasonal total or mean, averaged over years
SetupCdsCredentials	Configure CDS credentials for ERA5 data access
setup_cds_credentials	Configure CDS credentials for ERA5 data access
ShowCacheInfo	Show cache contents and statistics
show_cache_info	Show cache contents and statistics
spatial_mean	Spatial mean over grid points
sum_vars	Variables to sum over time

-- T --

time_operation

Measure the time of an operation and record the duration

-- U --

utci	Calculate UTCI (Universal Thermal Climate Index)
utci_category	UTCI thermal stress categories
utci_sparse	Calculate UTCI with a sparse regression approximation

-- V --

validate_bbox	Make sure that bounding box coordinates are valid
validate_coordinates	Make sure that geographic coordinates are valid
validate_era5_variables	Validate ERA5 variable names
vapor_pressure_from_dewpoint	Calculate vapor pressure from dewpoint temperature
varunayan-aliases	PascalCase Aliases
visualize_grid_overlap	Show the overlap of grid points and polygons

-- W --

warm_nights	Warm nights
wbgt	Wet Bulb Globe Temperature
wbgt_from_dewpoint	Calculate WBGT from dewpoint
wbgt_liljegren	Outdoor Wet Bulb Globe Temperature (Liljegren method)
wbgt_risk_category	Heat stress risk categories
wbgt_shade	Calculate shade/indoor Wet Bulb Globe Temperature (ISO 7243)
wbgt_simple	Calculate WBGT (Wet Bulb Globe Temperature)
wet_bulb_from_dewpoint	Calculate wet bulb temperature from dewpoint
wet_bulb_temperature	Calculate wet bulb temperature