opInformation: Package functions information

View source: R/opInformation.R

opInformationR Documentation

Package functions information

Description

A reminder of available functions from this package, and, most common usage intent. A poor man CLI cheat sheet.

Usage

opInformation()

Value

A data.table with following columns

name

the object name

category

the category of the object describe by function name. Could be CLASS, FUNCTION or DATA.

nature

either INTERNAL or EXPORTED.

stratum

the stratum the object belongs to. Values are CORE, LAYER_1, LAYER_2, LAYER_3.

phasing

main usage phase of the object. Values are DESIGN, BUILD, TEST, RUN, MAINTAIN, EVOLVE and TRANSVERSAL.

intent

main global intent of the object. Values are PARTS_BUILDING, PARTS_ASSEMBLY, QUALITY_CONTROL, FEEDBACK, STATISTICS, CONTENT_GENERATION and UTILITIES.

Author(s)

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

See Also

Refer also to package vignettes.

Examples

##---- typical case ----
opInformation()

wyz.code.offensiveProgramming documentation built on Sept. 25, 2023, 9:05 a.m.