nm_prefix: Add a prefix or suffix to the names of an object

In decisionpatterns/nameit: Functions for Working with Names

Description

Adds a prefix or suffix to the names attributes.

Usage

nm_prefix(x, prefix, sep = "", ...)

## Default S3 method:
nm_prefix(x, prefix, sep = "", ...)

## S3 method for class 'data.frame'
nm_prefix(x, prefix, sep = "", ...)

## S3 method for class 'data.table'
nm_prefix(x, prefix, sep = "", exclude_key = TRUE)

nm_suffix(x, suffix, sep = "", ...)

## Default S3 method:
nm_suffix(x, suffix, sep = "", ...)

## S3 method for class 'data.frame'
nm_suffix(x, suffix, sep = "", ...)

## S3 method for class 'data.table'
nm_suffix(x, suffix, sep = "", ..., exclude_key = TRUE)

Arguments

x	object with a names attribute
prefix	character; prefix collapsed to string by sep and added to the front of each name
sep	string used to collapse and seperate prefix or suffix from names. The default is not to use a separator.
...	additional arguments
exclude_key	logical; if TRUE do not mangle the object's keys. (DEFAULT: TRUE)
suffix	character; collapsed to string by sep and added to the back of each name.

Details

nm_prefix and nm_suffix add a prefix or suffix to the names of an object.

The method for data.table objects are modified by reference.

Value

An object with the names altered by a prefix or suffix. For data.tables, these are returned invisibly.

See Also

stringr.tools::str_prefix() which is used by these functions

(setnames)data.table::setattr()

(data.table::setnames)data.table::setattr()

Examples

# nm_prefix

  data(iris)
  iris <- nm_prefix( iris, "var_" )
  names(iris)

  data(iris)
  setDT(iris)
  nm_prefix( iris, "var_" )
  names(iris)

# nm_suffix
  data(iris)
  iris <- nm_suffix( iris, "_var" )
  names(iris)

  data(iris)
  setDT(iris)
  nm_suffix( iris, "_var" )
  names(iris)

decisionpatterns/nameit documentation built on Aug. 22, 2020, 4:18 a.m.