wyz.code.rdoc (version 1.1.19)

InputContext-class: Input Context

Description

Environment class InputContext. Defines and eases input context management.

Usage

InputContext(object_o_1,
             methodName_s_1 = NA_character_,
             packageName_s_1 = NA_character_,
             dataFilename_s_1 = NA_character_
)

Arguments

object_o_1

a single object or NULL

methodName_s_1

a single string value that is the method name to consider

packageName_s_1

a single string that is the target package name to use

dataFilename_s_1

a single string that is the data file name

Value

An object instance.

Information

Environment fields

beautifier	list
class_kind	character
class_name	character
data_name	NULL
dataFilename_s_1	character
file_name	character
hack_description	logical
instrumentationLevel	list
kind	double
kinds	character
methodName_s_1	character
number_replacements	integer
object_o_1	list
packageName_s_1	character
self	environment
typeFactory_o_1	environment

Environment methods

buildMethodName() generateConditionalMarker(force_b_1 = FALSE) generateConditionalMarker(Generatorforce_b_1 = FALSE) getFilename() getKind() getName() markerGenerator() produceAlias() produceArguments() produceAuthor() produceConcept() produceCustom_section() produceDescription() produceDetails() produceDocType() produceEncoding() produceExamples() produceFormat() produceKeyword() produceName() produceNote() produceRdOpts() produceRdversion() produceReferences() produceSeealso() produceSexpr() produceSource() produceSynopsis() produceTitle() produceUsage() produceValue() retrieveStrategy() setUseMarkers(value_b_1)

offensive programming - semantic naming

Class name compliance is TRUE.

offensive programming - function return types

Class owns no function return type instrumentation.

offensive programming - test case definitions

Class owns no test case definitions.

See Also

Class GenerationContext class ProcessingContext class and class ManualPageBuilder.

Examples

# NOT RUN {
ic1 <- InputContext(NULL)

ic2 <- InputContext(NULL, 'append', package = 'my.package.name')
# }