Title:	Tagging and Organizing Objects in R
Version:	1.0.1
Maintainer:	Joachim Zuckarelli <joachim@zuckarelli.de>
Description:	Provides functions for attaching tags to R objects, searching for objects based on tags, and removing tags from objects. It also includes a function for removing all tags from an object, as well as a function for deleting all objects with a specific tag from the R environment. The package is useful for organizing and managing large collections of objects in R.
BugReports:	https://github.com/jsugarelli/tagr/issues
URL:	https://github.com/jsugarelli/tagr/
License:	GPL-3
Encoding:	UTF-8
RoxygenNote:	7.1.1
NeedsCompilation:	no
Packaged:	2023-09-03 12:21:01 UTC; zucka
Author:	Joachim Zuckarelli [aut, cre]
Repository:	CRAN
Date/Publication:	2023-09-03 12:40:02 UTC

Add tags to an R object

Description

This function adds tags to an existing R object. The tags are stored as attributes of the object and can be later used to identify and manipulate the object. If the specified object does not exist in the specified environment, an error is thrown.

Usage

add_tags(x, ..., envir = parent.frame())

Arguments

Value

No return value.

Examples

# create a vector and add some tags
x <- c(1, 2, 3)
add_tags(x, "foo", "bar")

Remove the 'tags' attribute from an object

Description

This function removes the 'tags' attribute from an object, effectively removing all tags attached to the object. If the object does not have a 'tags' attribute, the function simply returns without modifying the object.

Usage

clean_tags(obj, envir = parent.frame())

Arguments

Value

No return value.

Examples

# create an object and add some tags
my_vec <- c(1, 2, 3)
add_tags(my_vec, "important", "numeric")

# remove the tags from the object
clean_tags(my_vec)

Check if an R object has specified tags

Description

This function checks if an existing R object has specified tags. The tags are stored as attributes of the object. If the specified object does not exist in the specified environment, an error is thrown.

Usage

has_tag(x, ..., envir = parent.frame())

Arguments

Value

A logical value indimessageing whether the object has all of the specified tags.

Examples

# create a vector and add some tags
x <- c(1, 2, 3)
add_tags(x, "foo", "bar")

# check if the vector has the specified tags
has_tag(x, "foo", "bar")

List objects in an environment by tag

Description

This function lists all objects in a specified environment that have all of the specified tags. The tags are stored as attributes of the objects. If the only.tags argument is set to TRUE, only objects that have at least one tag are listed. If no objects with the specified tags are found, a message is printed to the console. If the specified environment does not exist, an error is thrown.

Usage

ls_bytag(..., only.tags = TRUE, envir = parent.frame())

Arguments

Value

No return value. A table with information about each tagged object, including its name, type, and tags is printed to the console.

Examples

# create some objects and add tags
x <- c(1, 2, 3)
y <- matrix(1:9, nrow = 3)
z <- "hello world"
add_tags(x, "foo")
add_tags(y, "bar")
add_tags(z, "baz")

# list objects with specified tags
ls_bytag("foo", "bar")

Remove Objects by Tag

Description

Remove all objects in the current environment that have a specified tag.

Usage

rm_bytag(
  tag,
  envir = parent.frame(),
  confirm = getOption("tagsr.confirm", FALSE)
)

Arguments

Value

No return value.

See Also

add_tags, has_tag, ls_bytag

Examples

# create some objects with tags
x <- 1:10
y <- matrix(rnorm(16), 4, 4)
add_tags(x, "numbers")
add_tags(y, "matrix")

# remove all objects with the "numbers" tag
rm_bytag("numbers")

# remove all objects with the "matrix" tag without confirmation prompt
set_confirm(FALSE)
rm_bytag("matrix")

# confirm that objects have been removed
ls()

# clean up
rm(set_confirm, x, y)

Set confirmation prompt for deleting objects

Description

This function sets the confirmation prompt for the rm_bytag function when deleting objects with a specified tag.

Usage

set_confirm(confirm = NULL)

Arguments

Value

If confirm is NULL, the current setting for the confirmation prompt is returned. Otherwise, the confirmation prompt setting is updated.

Examples

# turn on confirmation prompt
set_confirm(TRUE)

# turn off confirmation prompt
set_confirm(FALSE)

# get current confirmation prompt setting
set_confirm()

Retrieve tags associated with an object

Description

This function retrieves the tags associated with a specified object.

Usage

tags(obj, envir = parent.frame())

Arguments

Value

Returns a sorted vector of tags associated with the object. If the object has no tags, the function prints a message and returns NULL.

Examples

# create a variable
x <- 5

# add tags to the variable
add_tags(x, "important", "numeric")

# retrieve the tags
tags(x)

Remove tags from an object

Description

This function removes one or more tags from an object. The tags to be removed can be specified as separate arguments or using the ellipsis ('...') syntax. Alternatively, setting 'all' to TRUE will remove all tags from the object. If the specified object does not have the specified tag(s), the function will throw an error. If 'all' is set to TRUE and the object has no tags, the function will do nothing.

Usage

untag(obj, ..., all = FALSE, envir = parent.frame())

Arguments

Value

No return value.

Examples

x <- 1:10
add_tags(x, "numbers", "positive")
add_tags(x, "even")
tags(x)
# "even", "numbers", "positive"

# Remove the "positive" tag from x
untag(x, "positive")
tags(x)
# "even", "numbers"

# Remove all tags from x
untag(x, all = TRUE)
tags(x)
# "NULL"