Function reference • r2q

All functions

Input_event(): Calculate pollutant input from runoff area area within a rain event

area_from_load(): Calculate pollutant input from runoff area area within a rain event

assess_all_hazards(): Runs function immission_assessment() for all substances that might pose a risk and returns the results in three tables

calculate_tolerable_discharge(): Calculate tolerable discharge

check_all_substances(): Check if substances pose a risk to the surface water

check_pollutant_impact(): Check Pollutant Impact

combine_concentration_tables(): Combine the three R2Q concentration tables (treshold values, background and stromwater)

get_HQ_time_interval(): get_HQ_time_intterval

get_Hq1_pnat(): Calculate natural runoff based on slope of landscape

get_KOSTRA(): Get KOSTRA rain characteristics

get_allowed_area(): Get allowed impervious area

get_default_background(): get background concentrations for SUW before rain events

get_functionsID(): Loads the table with function IDs

get_landuse_runoff(): Loads landuse specific pollutant runoff concentration obtained by the OgRe Dataset

get_planningLoad(): Load of one parameter from one specific surface

get_q_max(): Calculates tolerable hydraulic burden based on natural runoff estimation

get_rain(): get_rain

get_siteInfoID(): Load the table with site data variable IDs

get_spec_runoff(): This function loads the landuse specific pollutant runoff concentration obtained by the OgRe Dataset and multiplies it with the proportion of the correspoding area type in the catchment.

get_stormwaterRunoff(): Load landuse specific pollutant runoff concentration

get_subID(): Load the table with substance IDs

get_thresholds(): get substance thresholds for SUW during rain events

get_x(): Calculate acceptable additional runoff factor x

hydrology_assessment(): Maximal connectable impervious area based on hydrologic conditions

immission_assessment(): Automated immission assessment

lin_interpolation(): lin_interpolation

load_background_data(): Loading local background concentration

load_landuse(): Loading all details about catchment area types

load_planning_details(): Loads Excel sheet "planning_area_details"

load_site_data(): Loading site specific information

massUnit_tranformation(): Transforms the mass units ng, ug, mg and g

maxArea_event(): Calculate connectable area to a river based on pollutant input within a heavy rain event

maxArea_year(): Calculate connectable area in a river catchment based on a yearly regulated Substance

maxInput_year(): Calculate maximal yearly pollutant input

merge_by_pollutant(): How to merge two R2Q concentration tables

mixed_reactor_C(): Calculate the dynamic concentration in a river stretch

planning_area_discharge(): Calculates the pollutants load from the planning area into the surface water

plot_connectable_urban_area(): Plot of connectable area

plot_hazards(): Plots the output of function check_all_substances()

r2q_pal: Color palette for R2Q Plots

run_scenario(): Run immission-based tool

run_status_quo(): Run immission-based tool

sub_OgRe_to_name(): OgRe substance names are turned to substance names used in the tables

sub_id_to_name(): Substance IDs within the package data tables are turned to substance names

substr_reverse(): Start counting from the string end to get a substring