getTags.FullNameInterface: Gets the tags

getTags.FullNameInterfaceR Documentation

Gets the tags

Description

Gets the tags.

Usage

## S3 method for class 'FullNameInterface'
getTags(this, pattern=NULL, collapse=NULL, ..., named=FALSE, na.rm=TRUE,
  useCustomTags=TRUE)

Arguments

pattern

An optional regular expression used to filter out tags. If NULL, all tags are returned.

collapse

A character string used to concatenate the tags. If NULL, the tags are not concatenated.

...

Additional arguments passed to *getFullName().

named

If TRUE, tags of format "<name>=<value>" will be parsed as named "<value>" tags, e.g. "foo,n=23,bar,n=42" is parsed to c("foo", "n"="23", "bar", "n"="42"). Note that if collapse is FALSE, the names will be dropped.

na.rm

If TRUE and the fullname is NA, then NULL is returned, otherwise (character) NA is returned.

useCustomTags

If TRUE, custom tags are used, otherwise not.

Details

The tags of a fullname are the comma separated parts of the fullname that follows the the first comma, if any. For instance, the tags of foo,a.2,b are a.2 and b.

Any custom tag that equals "*" is replaced by the comma separated tags from the fullname.

Value

Returns a character vector (possibly NA) or NULL.

Author(s)

Henrik Bengtsson

See Also

*getFullName(). *getName(). For more information see FullNameInterface.


R.filesets documentation built on May 29, 2024, 9:10 a.m.