Arguments$getCharacters

From R.utils v1.32.4 by Henrik Bengtsson
0th

Percentile

Coerces to a character vector and validates

Coerces to a character vector and validates.

Keywords
methods, internal, IO
Usage
## Static method (use this):
## Arguments$getCharacters(s, length=NULL, trim=FALSE, nchar=NULL, useNames=TRUE,
##   asGString=getOption("Arguments$getCharacters/args/asGString", TRUE), .name=NULL,
##   ...)
## Don't use the below:
## S3 method for class 'Arguments':
getCharacters(static, s, length=NULL, trim=FALSE, nchar=NULL, useNames=TRUE,
  asGString=getOption("Arguments$getCharacters/args/asGString", TRUE), .name=NULL, ...)
Arguments
s
A vector.
nchar
A numeric vector of length one or two. If one, the maximum number of characters ("length") in s. If two, the minimum and maximum
useNames
If TRUE, the 'names' attribute is preserved, otherwise it is dropped.
asGString
If TRUE, each string is treated as a GString.
.name
A character string for name used in error messages.
...
Not used.
Value

  • Returns a character vector, if it is valid. Otherwise an exception is thrown.

See Also

For more information see Arguments.

Aliases
  • Arguments$getCharacters
  • getCharacters.Arguments
  • Arguments.getCharacters
  • getCharacters,Arguments-method
  • Arguments.getCharacter
  • getCharacter.Arguments
  • getCharacter,Arguments-method
Documentation reproduced from package R.utils, version 1.32.4, License: LGPL (>= 2.1)

Community examples

Looks like there are no examples yet.
API documentation
R package
Rdocumentation.org

Created by DataCamp.com

Put your R skills to the test Start Now