rhrHrAnalysis: Function to run perform analyses and save results to...

Description Usage Arguments Value Author(s)

View source: R/rhrHrAnalysis.R

Description

This functions wraps many rhr* methods. The purpose of this function to run a series of of estimates given data, a vector of desired results and a list with arguments.

Usage

1
2
3
4
5
rhrHrAnalysis(dat, what = c("rhrSiteFidelity", "rhrTTSI", "rhrMCP", "rhrKDE",
  "rhrAsymptote", "rhrCoreArea"), args = NULL, verbose = TRUE,
  outDir = file.path(tempdir(), paste0("rhr", format(Sys.time(),
  "%Y%m%d%H%M%S"))), inGUI = FALSE, inUnit = "ido", outUnit = "ius",
  report = TRUE, zip = FALSE, repArgs = NULL)

Arguments

dat

RhrMappedData

what

character vector; indicating which steps should be performed, order does not matter

args

list; with arguments for the different steps

verbose

logical; whether or not progress should be given on the command line

outDir

character; path to the directory where the results are saved.

inGUI

logical; indicating whether or not the call was made from a GUI

inUnit

character; units of the input

outUnit

character; units of the output

report

logical; indicating if a report should be created.

zip

logical; indicating if a zip archive should be created, note this most likely only works under linux.

repArgs

A list with extra arguments for the report.

Value

List

Author(s)

Johannes Signer


jmsigner/rhr documentation built on June 26, 2020, 8:59 a.m.