verifyClassName {wyz.code.offensiveProgramming}

Verify Class Name

Description

Verifies class name compliance with a policy.

Usage

verifyClassName(name_s = "MyClassName", strictSyntax_b_1 = TRUE)

Arguments

name_s

a string that is the class name to be checked

strictSyntax_b_1

A boolean value. When TRUE, allowed character set is [A-Za-z0-9]+. A class name must start with an uppercase letter. The name is required to be camel cased, although this cannot be checked.

When FALSE, allowed character set is [A-Za-z0-9_.]+. Classic R class naming applies.

Value

TRUE when name complies with policy, FALSE otherwise.

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

See Also

Refer to defineEvaluationModes.

Examples

##---- typical case ----
verifyClassName('matrix')
verifyClassName('matrix', FALSE)