loadSavedNlStat: Load the saved nlStat into an accessible environment

Description Usage Arguments Value Examples

View source: R/stats.R

Description

Load the saved nlStat into an accessible environment e.g. the global environment. This is especially required if the function is saved but not present in the Global environment or an environment where the package functions can access it

Usage

1
2
3
4
5
6
loadSavedNlStat(
  statSig,
  newStatName = NULL,
  envir = .GlobalEnv,
  overwrite = FALSE
)

Arguments

statSig

character The nlStat signature

newStatName

character The name to give the nlStat in the environment in case one does not want to use the name it is saved with

envir

character The environment in which to append the nlStat

overwrite

logical Whether to overwrite a function with the same name if it is present

Value

logical Whether the process was successful

Examples

1
2
3
4
5
6
## Not run: 
  loadSavedNlStat(statSig = "sum()", newStatName = "mySum", overwrite = TRUE)

## End(Not run)

#returns "sum"

chrisvwn/Rnightlights documentation built on Sept. 7, 2021, 1:44 a.m.