set_threshold: Set a threshold

Description Usage Arguments Value Examples

View source: R/ff_set_threshold.R

Description

Set tolerable extreme values (maximum or minimum). Records greater or equal than ('>=') or lesser or equal than ('<=') 'threshold' argument are set to NA_real_.

Usage

1
set_threshold(x, col_name, out_name = NULL, threshold, case = ">=")

Arguments

x

data frame with class Date in the first column and numeric on the others.

col_name

string with column(s) name(s) where to apply the function.

out_name

optional. String with new column(s) name(s). If you set it as NULL, the function will overwrite the original data frame.

threshold

numeric vector with the threshold value(s). If you provide a single value it will be recycled among col_name strings.

case

string with either '>=' (greater or equal than) or '<=' (lesser or equal than) symbol. Default string is '>='.

Value

The same data frame but with the threshold set.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# set path to file
path_file <- system.file('extdata', 'ianigla_cuevas.csv',
             package = 'hydrotoolbox')

# read with default names
cuevas <- read_ianigla(path = path_file,
                       out_name = c('tair(°C)', 'rh(%)', 'patm(mbar)',
                                    'p(mm)', 'wspd(km/hr)', 'wdir(°)',
                                    'kin(kW/m2)', 'hsnow(cm)', 'tsoil(°C)') )

# remove values higher than 1.50 meters
cuevas %>%
  set_threshold(col_name = 'hsnow(cm)',
                out_name = 'hsnow_thres',
                threshold = 150 )

hydrotoolbox documentation built on July 9, 2021, 1:06 a.m.