get_events_dir {hydropeak}R Documentation

Flow Fluctuation Events and Metrics from Input Directory

Description

Given a directory path it calls get_events_file() for each file in the directory, recursively. The resulting events are split into separate files for each gauging station ID (ID) and Event_Type and are written to the given output directory.

Usage

get_events_dir(
  Q_dir,
  inputsep = ";",
  inputdec = ".",
  outdir = file.path(tempdir(), "Events"),
  mc.cores = 2L,
  ...
)

Arguments

Q_dir

A character string containing the path name where the input data are located.

inputsep

Field separator character string for input data.

inputdec

Character string for decimal points in input data.

outdir

A character string naming a directory where the output file(s) should be written to.

mc.cores

Number of cores to use with parallel::mclapply(). On Windows, this will be set to 1.

...

Arguments to be passed to get_events_file() and further to get_events() and flow().

Value

No return value, called for side effects.

Examples

Q_dir <- "./inst/extdata"
get_events_dir(Q_dir, inputsep = ",", inputdec = ".")

[Package hydropeak version 0.1.2 Index]