pick_randomNames: Pick n random names from the randomNames package

View source: R/pick_randomNames.R

pick_randomNamesR Documentation

Pick n random names from the randomNames package

Description

The randomNames function from randomNames does not necessarily provide unique names (https://github.com/CenterForAssessment/randomNames/issues/55). Hence this function has been written to fix that issue as elegant as possible.

Usage

pick_randomNames(
  n,
  names_to_avoid = NULL,
  max_iter = 500,
  min_name_nchar = 3,
  avoid_chars = c(" ", "-", "'", ",", ";"),
  randomNames_args = list(which.names = "first")
)

Arguments

n

numeric (integer) of how many unique names to return

names_to_avoid

a vector of names to avoid

max_iter

maximum number of while-loop iterations to avoid an infinite loop

min_name_nchar

min length of name returned by randomNames

avoid_chars

character vector of forbidden characters in names or NULL; reject names with one or more of these characters

...

arguments passed to randomNames::randomNames

Value

a vector of n unique random names


Close-your-eyes/igsc documentation built on Jan. 28, 2024, 10:28 p.m.