getAllNlConfigNames: Generate a list of all possible configNames for a given...

Description Usage Arguments Examples

View source: R/tiles.R

Description

Generate a list of all possible configNames for a given nlType

Usage

1
2
3
4
5
6
7
8
getAllNlConfigNames(
  nlTypes = NULL,
  configNames = NULL,
  extensions = NULL,
  description = "short",
  printOut = FALSE,
  summary = FALSE
)

Arguments

nlTypes

if present show only configNames matching the nlTypes

configNames

if present show only configNames matching the configNames

extensions

if present show only extensions matching the extensions

description

(character) whether to print the long or short description. Possible values are:

  • NULL Do not show descriptions

  • short Show short descriptions

  • long Show long descriptions

printOut

Whether to print the output. Output may be formatted to aid viewing.

summary

Return a summarized view showing only abbrevs.

Examples

1
2
getAllNlConfigNames("OLS.Y")
 #returns '"cf_cvg", "avg_vis", "stable_lights"'

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