check.text.args: Text argument validator

Description Usage Arguments Author(s) Examples

View source: R/metaseqr.argcheck.R

Description

Checks if one or more given textual argument(s) is/are member(s) of a list of correct arguments. It's a more package-specific function similar to match.arg. Mostly for internal use.

Usage

1
2
    check.text.args(arg.name, arg.value, arg.list, 
        multiarg=FALSE)

Arguments

arg.name

the name of the argument that is checked (for display purposes).

arg.value

the value(s) of the argument to be checked.

arg.list

a vector of valid argument values for arg.value to be matched against.

multiarg

a logical scalar indicating whether arg.name accepts multiple arguments or not. In that case, all of the values in arg.value are checked against arg.list.

Author(s)

Panagiotis Moulos

Examples

1
2
3
4
5
6
# OK
check.text.args("count.type","gene",c("gene","exon"),
    multiarg=FALSE)
## Error!
#check.text.args("statistics","ebseq",c("deseq","edger",
#    "noiseq","bayseq","limma"), multiarg=TRUE)

metaseqR documentation built on Nov. 8, 2020, 5:57 p.m.