postHoc: Add a post hoc analysis function to a 'map' object

mapAddPostHocAnalysisR Documentation

Add a post hoc analysis function to a map object

Description

Add a post hoc analysis function to a map object

Usage

mapAddPostHocAnalysis(
  map,
  functionName,
  postHocAnalysisGroups = NULL,
  postHocAnalyses = "all",
  useParallel = getOption("map.useParallel", FALSE),
  ...
)

Arguments

map

Optional map object. If not provided, then one will be created. If provided, then the present obj or options passed to reproducible::prepInputs() (e.g., url), will be appended to this map.

functionName

A function that is designed for post hoc analysis of map class objects, e.g., rbindlistAG.

postHocAnalysisGroups

Character string with one analysisGroups, i.e., "analysisGroup1" or "analysisGroup2".

postHocAnalyses

Character vector with "all", (which will do all analysisGroups; default), or 1 or more of the the functionNames that are in the analyses slot.

useParallel

Logical. If TRUE, then if there is more than one calculation to do at any stage, it will create and use a parallel cluster via pemisc::makeOptimalCluster(). If running analyses in parallel, it may be useful to pass a function (via .clInit) to be run on each of the nodes immediately upon cluster creation (e.g., to set options).

...

Optional arguments to pass into functionName


PredictiveEcology/map documentation built on June 15, 2025, 6:15 a.m.