FastUtils: Fast, Readable Utility Functions

Description

A wide variety of tools for general data analysis, wrangling, spelling, statistics, visualizations, package development, and more. All functions have vectorized implementations whenever possible. Exported names are designed to be readable, with longer names possessing short aliases.

Author(s)

Maintainer: Qile Yang qile.yang@berkeley.edu [copyright holder]

See Also

Useful links:

• https://github.com/Qile0317/FastUtils

• https://qile0317.github.io/FastUtils/

• Report bugs at https://github.com/Qile0317/FastUtils/issues/

Add Two Objects

Description

This function adds two objects. If both objects are numeric vectors, it performs element-wise addition. If one or both objects are strings, it concatenates them. For other objects, it attempts to use the + method defined for the class of the objects.

Usage

add(x, y)

Arguments

Value

The result of adding the two objects.

Examples

# Add two numeric vectors
add(c(1, 2, 3), c(4, 5, 6))
# Concatenate two strings
add("hello", "world")
# Add a number and a string (concatenation)
add(1, " world")

Bound a Number within a Range

Description

This function bounds a number within a specified range. This function is vectorized in a way such that either or both lowerbound and upperbound can be length 1 or the same length as the input vector.

Usage

bound(num, lowerbound, upperbound)

Arguments

Value

A numeric vector with elements bounded within the specified range.

Examples

bound(1, 0, 2)
bound(1:10, -1, 5)

Find the Closest Word in a Set to a Given Word

Description

This function finds the closest word in a set of words to a given word based on a specified distance function.

Usage

closestWord(s, strset, distFunc = utils::adist)

Arguments

Value

The closest word in the set to the given word.

Examples

# Find the closest word to "hello" in the set c("hallo", "hullo", "hey")
closestWord("hello", c("hallo", "hullo", "hey"))

Convert a Column to Row Names

Description

This function converts a specified column of a data frame to row names, ensuring uniqueness if necessary.

Usage

colToRownames(df, col, .remove = TRUE, .uniqueSep = ".")

Arguments

Value

A data frame with the specified column as row names. If .remove is TRUE, the original column is removed.

See Also

mutateToRownames()

Examples

# Convert the 'ID' column to row names
df <- data.frame(ID = c("A", "B", "C"), Value = c(10, 20, 30))
colToRownames(df, "ID")
# Convert the 'ID' column to row names and keep the column
df <- data.frame(ID = c("A", "B", "C"), Value = c(10, 20, 30))
colToRownames(df, "ID", .remove = FALSE)

Create a Hash Table

Description

This function creates a hash table from a set of keys and optional initial value. Note that it is simply a convenience wrapper for the hash package.

Usage

createHash(keys, initVals = NULL)

Arguments

Value

A hash table with the specified keys and initial values.

Examples

# Create a hash table with keys and no initial values
createHash(c("a", "b", "c"))
# Create a hash table with keys and initial value of 0
createHash(c("a", "b", "c"), 0)

Create a Mutator Function

Description

Creates a mutator function based on a specified binary operator. The output mutator function updates a variable in the parent frame by applying the binary operator with a given value. It's recommended to use this function to easily construct special functions in the form of ⁠%f%⁠ where f can be any symbol of choice. See examples.

Usage

createMutator(binaryOperator)

Arguments

Value

A function that takes a variable and a value, applying the binary operator to update the variable in the parent frame.

Examples

"%+=%" <- createMutator(add)
x <- 1
x %+=% 1
x # becomes 2

Create Package Loader Function

Description

This function creates a package loader function that can install and load packages from CRAN, Bioconductor, or GitHub, optionally displaying verbose output. This function can be useful in new R instances with little dependencies available.

The function takes the following arguments:

• cran

• bioc

• gh

• verbose

where cranandbioc⁠take character vectors of package names on CRAN and Bioconductor, while⁠gh⁠takes character vectors with the formatting⁠githubUsername/packageName. verbose' takes in a logical for whether to display additional informative messages in the REPL.

The function will not install packages that can already be loaded by default.

Usage

createPkgLoader(lib = .libPaths()[1])

Arguments

Value

A function that installs and loads packages.

Examples

# Create the package loader function
loader <- createPkgLoader()

# # commented usage example
# loader(
#   cran = c("dplyr", "ggplot2"),
#   bioc = c("GenomicRanges", "Biobase"),
#   gh = c("tidyverse/dplyr"),
#   verbose = FALSE
# )

Divide Two Numbers

Description

This function divides one number by another.

Usage

divide(x, y)

Arguments

Value

A numeric vector representing the quotient of the input vectors.

Examples

# Divide two numeric vectors
divide(c(10, 20, 30), c(2, 4, 5))

Enclose String with Specified Characters

Description

This function encloses a string with specified characters on the left and the right.

Usage

enclose(x, left, right)

Arguments

Value

A new character string with x enclosed by left and right.

Examples

enclose("text", "[", "]") # returns "[text]"

Enclose String with Brackets

Description

This function encloses a string with parentheses.

Usage

encloseBr(x)

Arguments

Value

A new character string with x enclosed by parentheses.

Examples

encloseBr("text") # returns "(text)"

Enumerate Elements with Indices

Description

This function pairs elements of vectors or lists with their indices. The output is meant to be used in a for loop, and each element extracted with the ind(), val(), or val1() functions. A slightly lighter weight alternative to itertools::enumerate()

Usage

enumerateit(..., zeroIndexed = FALSE)

Arguments

Value

A list of lists, where each inner list contains an index and the corresponding elements from the input vectors or lists.

See Also

ind(), val(), val1()

Examples

# Enumerate a vector
enumerateit(c("a", "b", "c"))
# Enumerate a vector starting from zero
enumerateit(c("a", "b", "c"), zero_indexed = TRUE)
# Enumerate two vectors
enumerateit(c(1, 2), c("x", "y"))

evaluates a string as R code, and stops if an error occurs

Description

This function evaluates a string as R code, and stops if an error occurs. This can be useful for evaluating code that is generated dynamically.

Usage

evalText(..., envir = parent.frame())

Arguments

Value

the result of the evaluation

Examples

# Set names of a vector
x <- 1:3
x <- evalText("setNames(x, c('A', 'B', 'C'))")
x

Find Missing Sections in Rd Files

Description

This function scans Rd documentation files in the specified package's ⁠\man⁠ directory to identify which functions lack certain documentation sections like ⁠\examples⁠. If there are no missing sections in all the Rd files, then the output is a character(0)

Usage

findMissingRdSections(
  sectionName,
  pkg = ".",
  ignore = NULL,
  .ignore = "-package$"
)

fmrs(sectionName, pkg = ".", ignore = NULL, .ignore = "-package$")

Arguments

Value

Character vector of function names that are missing any of the specified sections in their Rd files. May be length 0 if all fulfill criteria.

Examples

try(
  findMissingRdSections(c("examples", "example"), pkg = "."),
  silent = TRUE
)

Fix Column Names

Description

This function fixes the column names of a given object so that all words are spaced by a specified delimiter, and any special characters are replaced according to a substitution map.

Usage

fixColnames(
  object,
  invalidRegex = joinRegex(" ", "\\)", "\\(", "\\.", "/"),
  spacing = "_",
  subMap = NULL,
  .subMap = list(`%+` = "pct", `\\$+` = "dollars", `\\++` = "plus", `-+` = "minus",
    `\\*+` = "star", `#+` = "cnt", `&+` = "and", `@+` = "at"),
  unique = FALSE
)

Arguments

Value

The data frame or matrix with fixed column names.

Examples

# Fix column names of a data frame
df <- data.frame(
    `A (1)` = c(1, 2, 3), `B/C` = c(4, 5, 6), `D+E` = c(7, 8, 9)
)
fixColnames(df)

Compute the Average of Hex Colors

Description

This function computes the average color of the provided hex color values.

Usage

getAvgHex(...)

Arguments

Value

A single hex color character representing the average of the input colors.

Source

https://stackoverflow.com/questions/649454

Examples

getAvgHex("#000000", "#FF00FF")
getAvgHex(c("#008040", "#000000", "#FF00FF"))

# very nonstandard but possible way to input hexes. Essentially,
# any combination of vectors will work.
getAvgHex(list("#008040", "#000000"), "#FF00FF", c("#FF00FF"))

Get a Character at a Specific Index

Description

This function retrieves a character at a specific index from a string.

Usage

getChar(x, index)

Arguments

Value

The character at the specified index.

Examples

# Get the character at index 2
getChar("hello", 2)

Get Failure Message as a character

Description

This function generates a failure message string from a given condition. The message includes the context of the call and the specific condition message.

Usage

getFailStr(cond)

Arguments

Value

A character string containing the failure message.

Examples

tryCatch(stop("Example error"), error = function(e) getFailStr(e))

Get Keywords from R Package Documentation

Description

This function retrieves keywords from all package documentation files located in the ⁠/man⁠ directory of the specified R package. It can return a unique list of keywords or a frequency distribution of these keywords as a table object, sorted by the keys.

Note that the "internal" keyword is ignored.

Usage

getPkgKeywords(pkg = ".", asDistribution = FALSE)

Arguments

Value

If asDistribution is FALSE, a sorted character vector of unique keywords is returned. If asDistribution is TRUE, a table of keywords and their frequencies is returned. If no keywords were detected, returns a character of length 0.

Examples

getPkgKeywords()
getPkgKeywords(asDistribution = TRUE)

Get the dimensions of a ggplot Object

Description

This function retrieves the minimum and maximum x and y dimensions of a ggplot object. Note that it is the dimension of the plot within the x and y axis and not the dimensions of the actual output image itself. This may be useful for numerical computations when modifying plots, but can be slow since it builds the actual plot first.

Usage

getPlotDims(plt)

Arguments

Value

A list with elements xr (a vector of xmin and xmax) and yr (a vector of ymin and ymax).

Examples

library(ggplot2)
getPlotDims(ggplot(mtcars) + geom_point(aes(mpg, cyl)))

Generate Unique Pairs Up To a Number

Description

This function generates all unique pairs of integers up to a given number.

Usage

getUniquePairsUpTo(x, oneIndexed = TRUE)

Arguments

Value

A list of unique pairs of integers up to the specified number.

Examples

# Generate unique pairs up to 3 (one-indexed)
getUniquePairsUpTo(3)
# Generate unique pairs up to 3 (zero-indexed)
getUniquePairsUpTo(3, oneIndexed = FALSE)

Get the First Elements of a Vector or List

Description

This function retrieves the first n elements of a vector or list.

Usage

getfirst(x, n = 1)

## Default S3 method:
getfirst(x, n = 1)

Arguments

Value

The first n elements of the input.

Examples

# Get the first element of a vector
getfirst(c(1, 2, 3, 4, 5))
# Get the first 2 elements of a vector
getfirst(c(1, 2, 3, 4, 5), 2)
# Get the first element of a list
getfirst(list("a", "b", "c"))
# Get the first 2 elements of a list
getfirst(list("a", "b", "c"), 2)

Get the Last Elements of a Vector or List

Description

This function retrieves the last n elements of a vector or list.

Usage

getlast(x, n = 1)

## Default S3 method:
getlast(x, n = 1)

Arguments

Value

The last n elements of the input.

Examples

# Get the last element of a vector
getlast(c(1, 2, 3, 4, 5))
# Get the last 2 elements of a vector
getlast(c(1, 2, 3, 4, 5), 2)
# Get the last element of a list
getlast(list("a", "b", "c"))
# Get the last 2 elements of a list
getlast(list("a", "b", "c"), 2)

Search for a Pattern in Files within a Directory

Description

The greplDir function searches for a specified pattern in all files within a given directory. It allows for optional exclusion of files matching a specified regular expression. Note that all files are assumed to be a single string, with each line joined by the newline character "\n".

Usage

greplDir(fpattern, dirPath = getwd(), fIgnoreRegex = NULL, ...)

Arguments

Value

A named logical vector indicating which files contain the pattern. The names attribute contains the file names.

Examples

result <- tryCatch(
  greplDir("error", fIgnoreRegex = "\\.log$"),
  warning = function(w) c(exFname = TRUE),
  error = function(e) c(exFname = TRUE)
)
# its even more useful to use `base::which` on the result to
# get matches and mismatches - this returns it with names
# by default
which(result)
which(!result)

Get Index from Enumerated Element

Description

This function extracts the index from an enumerated element.

Usage

ind(elem)

Arguments

Value

The index of the enumerated element.

See Also

enumerateit()

Examples

# Extract index from an enumerated element
elem <- list(1, "a")
ind(elem)

Initialize a DataFrame with Column Names

Description

This function creates an empty data frame and assigns the specified column names with zero rows.

Usage

initDataFrameWithColnames(colnames = NULL)

Arguments

Value

A data frame with the specified column names. Non unique names will be handled by the conventions of data.frame(). prefixes.

Examples

# Create a data frame with specified column names initialized with NA
initDataFrameWithColnames(c("Name", "Age", "Gender"))

Initialize an Empty Table

Description

This function initializes an empty table.

Usage

initEmptyTable()

Value

An empty table structure.

Examples

# Create an empty table
initEmptyTable()

Initialize a List

Description

This function initializes a list based on size or names, with an optional initial value.

Usage

initList(x = NULL, initVal = NULL)

Arguments

Value

A list of the specified size and names, optionally initialized with a value.

Examples

# Create a list with 3 elements
initList(3)
# Create a named list initialized with NULL
initList(c("a", "b", "c"))
# Create a list with 2 elements initialized with 0
initList(2, 0)

Initialize Testthat Files

Description

This function scans all files in the specified R directory based on its name, excluding some based on the patterns provided in the ignore argument, and creates testthat files if they are missing. Useful for when many source code files were created from rapid development and unit testing has yet to be setup.

Usage

initTestthat(
  rDir = "R",
  testDir = file.path("tests", "testthat"),
  .ignore = c("-package.R$", "-class.R$", "^data.R$", "^zzz.R$", "^RcppExports.R$"),
  ignore = NULL
)

Arguments

Value

No return value, called for side effects.

Examples

try({

initTestthat()
initTestthat(rDir = "src", testDir = "tests")
initTestthat(ignore = c("^foo", "-bar.R$"))

}, silent = TRUE)

Initialize a Vector

Description

This function initializes a vector based on a specified type and size, with an optional initial value.

Usage

initV(typeFunc, x, initVal = NULL)

Arguments

Value

A vector of the specified type and size, optionally initialized with a value.

Examples

# Create a numeric vector of length 5
initV("numeric", 5)
# Create a logical vector of length 3 initialized with TRUE
initV("logical", 3, TRUE)

Check if a Number is within a Range

Description

This function checks if a number is within a specified range. This function is vectorized in a way such that either or both lowerbound and upperbound can be length 1 or the same length as the input vector.

Usage

isBound(num, lowerbound, upperbound)

Arguments

Value

A logical vector indicating whether each element is within the specified range.

Examples

isBound(1, 0, 2)
isBound(1:10, -1, 5)

Check if String is camelCase

Description

This function checks if a given string adheres to camelCase naming conventions, starting with a lowercase letter followed by any combination of upper and lower case letters.

Usage

isCamelCase(x)

Arguments

Value

TRUE if the string is camelCase, FALSE otherwise.

Examples

isCamelCase("camelCase")   # returns TRUE
isCamelCase("CamelCase")   # returns FALSE
isCamelCase("camelcase")   # returns TRUE

Check if a Number is Even

Description

This function checks if a number is even.

Usage

isEven(x)

Arguments

Value

A logical vector indicating whether each element is even.

Examples

# Check if numbers are even
isEven(c(1, 2, 3, 4))

Check if a Number is Odd

Description

This function checks if a number is odd.

Usage

isOdd(x)

Arguments

Value

A logical vector indicating whether each element is odd.

Examples

# Check if numbers are odd
isOdd(c(1, 2, 3, 4))

Check if String is PascalCase

Description

This function checks if a given string adheres to PascalCase naming conventions, starting with an uppercase letter followed by any combination of upper and lower case letters.

Usage

isPascalCase(x)

Arguments

Value

TRUE if the string is PascalCase, FALSE otherwise.

Examples

isPascalCase("PascalCase") # returns TRUE
isPascalCase("pascalCase") # returns FALSE
isPascalCase("Pascalcase") # returns TRUE

Check if String is snake_case

Description

This function checks if a given string adheres to snake_case naming conventions. By default (strict = TRUE), it only allows lowercase letters separated by underscores. If strict is FALSE, uppercase letters are also permitted.

Usage

isSnakeCase(x, strict = TRUE)

Arguments

Value

TRUE if the string is snake_case according to the specified strictness, FALSE otherwise.

Examples

isSnakeCase("snake_case")        # returns TRUE
isSnakeCase("Snake_Case")        # returns FALSE
isSnakeCase("snake_case", FALSE) # returns TRUE
isSnakeCase("Snake_Case", FALSE) # returns TRUE

Check if a Character is a Vowel

Description

This function checks if a character is a vowel.

Usage

isVowel(x)

Arguments

Value

TRUE if the character is a vowel, FALSE otherwise.

Examples

# Check if 'a' is a vowel
isVowel("a")
# Check if 'b' is a vowel
isVowel("b")

Join regex expressions by union

Description

This function simply joins a vector of regex characters by union, and produces a single character regex in the form of (foo)|(bar).

Usage

joinRegex(...)

Arguments

Value

a character of the unioned regex

Examples

joinRegex(c("^foo", "bar$"))
joinRegex("^foo", "bar$", "[bB]az")

List Only Files in a Directory

Description

This function lists only the files in a specified directory, excluding directories. It is useful when you need to process or analyze only the files within a directory without including subdirectories. The base::list.files() function lists both files and directories, so this function provides a more convenient way to obtain just the files.

Usage

listFiles(dirPath, ...)

Arguments

Value

A character vector of file paths.

Examples

listFiles(getwd())
listFiles(getwd(), pattern = "\\.R$", recursive = TRUE)

Multiply Two Numbers

Description

This function multiplies two numbers.

Usage

multiply(x, y)

Arguments

Value

A numeric vector representing the product of the input vectors.

Examples

# Multiply two numeric vectors
multiply(c(2, 3, 4), c(5, 6, 7))

Mutate columns to Row Names

Description

This function sets new row names for a data frame based on a tidy evaluation expression.

Usage

mutateToRownames(.data, expr, .remove = FALSE, .uniqueSep = ".")

Arguments

Value

A data frame with updated row names.

Examples

library(dplyr)

mtcars %>%
    head() %>%
    mutateToRownames(wt + 3*vs)

Convert Named Numeric Vector to Table

Description

This function converts a named numeric vector to a table.

Usage

namedNumericToTable(x)

Arguments

Value

A table with the same names and values as the input vector.

Examples

# Convert a named numeric vector to a table
vec <- c(a = 1, b = 2, c = 3)
namedNumericToTable(vec)

Prepend an Indefinite Article to a String

Description

This function prepends an indefinite article ("a" or "an") to a string based on whether it starts with a vowel or not.

Usage

prependIndefArticle(x)

pia(x)

Arguments

Value

The string with an indefinite article prepended.

Examples

# Prepend an indefinite article to "apple"
prependIndefArticle("apple")
# Prepend an indefinite article to "banana"
prependIndefArticle("banana")

Suppress Messages and Output

Description

This function suppresses messages and captures output from an expression. Note that this does NOT return the result of the expression! It is intended to be used in contexts where certain operations with side effects are performed but the verbosity should be suppressed.

Usage

quietly(e)

Arguments

Value

The result of the expression with messages suppressed and output captured.

Examples

quietly(print(1))

quietly({
    print(1)
    print(2)
    print(3)
})

a <- 1
quietly({
    a <- a + 1
    print(a)
})
print(a)
#> 2

Remove New Snapshots from vdiffr Tests

Description

This function removes new snapshots created by vdiffr tests. It is useful when you want to remove new snapshots that were created during testing and are no longer needed.

Usage

removeVdiffrNewSnapShots(
  pkg = getwd(),
  snapDir = file.path("tests", "testthat", "_snaps"),
  verbose = TRUE
)

rmns(
  pkg = getwd(),
  snapDir = file.path("tests", "testthat", "_snaps"),
  verbose = TRUE
)

Arguments

Value

NULL (invisible) - used for side effects

Examples

removeVdiffrNewSnapShots()

Remove Elements with Specified Name Regex

Description

This function removes elements from an indexable object (e.g., a named vector or list) where the names match a specified regular expression.

Usage

rmByName(x, pattern, silent = FALSE)

Arguments

Value

The input object with elements removed based on the name regex.

Examples

myList <- list(a = 1, b_test = 2, c = 3, d_test = 4)
rmByName(myList, "_test")

Convert Row Names to a Column

Description

This function converts the row names of a data frame to a specified column. Note that if the specified column already exists, it is overwritten.

Usage

rownamesToCol(df, colname = "rownames")

Arguments

Value

A data frame with the row names converted to a column.

Examples

# Convert row names to a column named 'ID'
df <- data.frame(Value = c(10, 20, 30))
rownames(df) <- c("A", "B", "C")
rownamesToCol(df, "ID")

Scale the Brightness of a Hex Color

Description

This function scales the brightness of hex colors by a given factor.

Usage

scaleHex(hex, scaleFactor)

Arguments

Value

A hex color value with adjusted brightness.

Examples

scaleHex("#404040", 2)

Set Column Names

Description

This function sets new column names for a given data frame or matrix.

Usage

setColnames(object, newColnames)

Arguments

Value

The data frame or matrix with updated column names.

Examples

# Set new column names for a data frame
df <- data.frame(A = c(1, 2, 3), B = c(4, 5, 6))
setColnames(df, c("X", "Y"))

Set Names of an Object

Description

Improvement to stats::setNames() sets new names for an object, ensuring that the length of the new names matches the length of the object. Additionally, if the length of newNames is one, it is repeated to match the length of the object.

Usage

setNames(object, newNames)

Arguments

Value

The object with updated names.

Examples

# Set new names for a vector
x <- c(1, 2, 3)
x <- setNames(x, c("A", "B", "C"))

# some syntactic sugar can be achieved with a special mutator
`%setNames%` <- createMutator(setNames)
x %setNames% c("D", "E", "F")

Set Row Names

Description

This function sets new row names for a given data frame or matrix.

Usage

setRownames(object, newRownames)

Arguments

Value

The data frame or matrix with updated row names.

Examples

# Set new row names for a data frame
df <- data.frame(A = c(1, 2, 3), B = c(4, 5, 6))
setRownames(df, c("row1", "row2", "row3"))

Split CamelCase or PascalCase Strings

Description

This function splits strings formatted in camelCase or PascalCase into their component words. It can handle words where uppercase letters transition to lowercase letters, and it is capable of handling strings with sequences of uppercase letters followed by lowercase letters, effectively separating acronyms from camelCase beginnings.

Usage

splitCamel(x, conseq = TRUE)

splitPascal(x, conseq = TRUE)

Arguments

Value

A list of character vectors, each containing the parts of the corresponding CamelCase or PascalCase string split at the appropriate transitions. If conseq is FALSE, acronyms followed by words are separated.

Source

<stackoverflow.com/questions/8406974/splitting-camelcase-in-r>

Examples

splitCamel("splitCamelCaseIntoWords")
splitCamel(c("fooBar", "FOOBar", "anotherFOOBarTest"), conseq = FALSE)

Split Snake Case String

Description

This function splits a string formatted in snake_case into its component words, using underscores as delimiters. It is useful for parsing identifiers or variable names that follow snake_case naming conventions.

Usage

splitSnake(x)

Arguments

Value

A list of character vectors, each containing the parts of the string split at underscores.

Examples

splitSnake("this_is_snake_case")
splitSnake("another_example_here")

Check if a String Starts with a Vowel

Description

This function checks if a string starts with a vowel.

Usage

startsWithVowel(x)

Arguments

Value

TRUE if the string starts with a vowel, FALSE otherwise.

Examples

# Check if "apple" starts with a vowel
startsWithVowel("apple")
# Check if "banana" starts with a vowel
startsWithVowel("banana")

Custom Stop Function Without Call

Description

This function provides a wrapper around the base stop() function, but it automatically sets call. to FALSE, which means the function call itself is not included in the resulting error message. This makes error messages cleaner. The domain argument can be used to specify a translation domain.

Usage

stopp(..., domain = NULL)

Arguments

Value

No return value, this function stops execution of the program.

See Also

stop()

Examples

try(stopp("This is a custom stop message without the call."), silent = TRUE)

Remove Spaces from a String

Description

This function removes spaces from a character string.

Usage

stripSpaces(x)

Arguments

Value

The string with spaces removed.

Examples

# Remove spaces from "hello world"
stripSpaces("hello world")

Extract Substring from Start to End Difference

Description

Extract a substring from a given start position to the position determined by subtracting endDiff from the string length.

Usage

substrEnd(x, start, endDiff)

Arguments

Value

A substring of the input character string.

See Also

substr()

Examples

substrEnd("12345", 1, 1)
substrEnd("12345", 1, 2)
substrEnd("12345", 2, 3)

Subtract Two Numbers

Description

This function subtracts one number from another.

Usage

subtract(x, y)

Arguments

Value

A numeric vector representing the difference between the input vectors.

Examples

# Subtract two numeric vectors
subtract(c(10, 20, 30), c(1, 2, 3))

Convert a Table to Numeric

Description

This function converts a table to a numeric vector.

Usage

tableToNumeric(x)

Arguments

Value

A numeric vector with names preserved from the table.

Examples

# Convert a table to numeric
tbl <- table(c("a", "b", "a"))
tableToNumeric(tbl)

Run a Testthat test Quietly

Description

This function runs a test_that block quietly, suppressing messages and output from any verbose functions.

Usage

test_quietly_that(desc, code)

Arguments

Value

No return value, called for side effects.

Examples

# Run a test quietly
test_quietly_that("quiet test example", {
    testthat::expect_equal(1 + 1, 2)
})

Try to Split Words Based on Naming Convention

Description

This function attempts to split characters into its component words (and by default, all in lowercase) based on camelCase, PascalCase, or snake_case conventions. If the string doesn't match any of these conventions, it returns all groups of letters.

Usage

trySplitWords(..., conseq = TRUE, strictSnake = FALSE, uncase = TRUE)

Arguments

Value

A list of character vectors, each containing the parts of the string split into individual words.

See Also

splitCamel, splitPascal, splitSnake, isCamelCase, isPascalCase, isSnakeCase

Examples

trySplitWords("camelCaseExample")
trySplitWords("PascalCaseExample")
trySplitWords(
    "snake_case_example", c("more_snake_cases"), "third_snake_case"
)
trySplitWords("some|random|case")
trySplitWords("Space Words", "UPPER_CASE", uncase = TRUE)

Get Value from Enumerated Element by Index

Description

This function extracts the value from an enumerated element by the given index.

Usage

val(elem, index)

Arguments

Value

The value at the specified index in the enumerated element.

See Also

enumerateit()

Examples

# Extract value from an enumerated element by index
elem <- list(1, "a", "b")
val(elem, 2)

Get First Value from Enumerated Element

Description

This function extracts the first value from an enumerated element.

Usage

val1(elem)

Arguments

Value

The first value in the enumerated element.

See Also

enumerateit()

Examples

# Extract the first value from an enumerated element
elem <- list(1, "a", "b")
val1(elem)

Validate Object

Description

This function validates an object using a list of checks. If any check fails, an error handler is called and a default value is returned. This function is intended to slightly simplify cases where a long list of complex and convoluted predetermined checks are needed. For simpler cases like type checking, it is recommended to use stopifnot() or assertthat::assert_that().

Usage

validateObject(obj, checks, errorHandler = warningp, defaultReturn = NULL)

Arguments

Value

The original object if all checks pass, or defaultReturn if any check fails.

Examples

# Define some checks
checkNotNull <- function(x) if (is.null(x)) "Object is NULL" else NULL
checkIsNumeric <- function(x) {
    if (!is.numeric(x)) "Object is not numeric" else NULL
}

# Validate an object
obj <- 42
validateObject(obj, list(checkNotNull, checkIsNumeric))

# Validate an object that fails a check
obj <- NULL
try(
    validateObject(
        obj,
        list(checkNotNull, checkIsNumeric, errorHandler = stop)
    ),
    silent = TRUE
)

Custom Warning Function Without Call

Description

This function provides a wrapper around the base warning function, adding flexibility to warnings by setting call. to FALSE automatically. This modification means that the function call is not included in the warning message, streamlining the output for users.

Usage

warningp(...)

Arguments

Value

No return value, this function issues a warning.

See Also

warning

Examples

try(warningp(
    "This is a custom warning message without the call."
), silent = TRUE)

Zip Multiple Vectors or Lists

Description

This function combines multiple vectors or lists element-wise into a list of lists. It's a slightly lighter weight alternative to itertools::izip()

Usage

zipit(...)

Arguments

Value

A list of lists, where each inner list contains the elements from the corresponding positions in the input vectors or lists.

See Also

enumerateit()

Examples

# Zip two vectors
zipit(c(1, 2, 3), c("a", "b", "c"))
# Zip three vectors
zipit(c(1, 2), c("x", "y"), c(TRUE, FALSE))