rm_spike: Remove spikes

Description Usage Arguments Value Examples

View source: R/ff_rm_spike.R

Description

Remove spikes and set their value as NA_real_.

Usage

1
rm_spike(x, col_name, out_name = NULL, tolerance)

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.

tolerance

numeric vector with the maximum tolerance between a number and its successor. If you provide a single value it will be recycled.

Value

The same data frame but with the peaks removed.

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 spikes in snow heigh series
cuevas %>%
  rm_spike(col_name = 'hsnow(cm)',
           out_name = 'hsnow',
           tolerance = 50) # 50 cm of snow its OK for this zone

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