| Version: | 1.6-0.0 |
| Date: | 2024-5-2 |
| Title: | Generate Random Given and Surnames |
| Depends: | R (≥ 4.0) |
| Suggests: | knitr, rmarkdown |
| Imports: | crayon, data.table (≥ 1.14.0), toOrdinal (≥ 1.1) |
| Maintainer: | Damian W. Betebenner <dbetebenner@nciea.org> |
| Description: | Function for generating random gender and ethnicity correct first and/or last names. Names are chosen proportionally based upon their probability of appearing in a large scale data base of real names. |
| URL: | https://centerforassessment.github.io/randomNames/,https://github.com/CenterForAssessment/randomNames/,https://cran.r-project.org/package=randomNames |
| BugReports: | https://github.com/CenterForAssessment/randomNames/issues/ |
| VignetteBuilder: | knitr |
| LazyLoad: | Yes |
| LazyData: | Yes |
| LazyDataCompression: | xz |
| ByteCompile: | TRUE |
| License: | GPL-3 |
| NeedsCompilation: | no |
| Packaged: | 2024-05-03 18:44:15 UTC; conet |
| Author: | Damian W. Betebenner [aut, cre], Lambert Joshua [ctb] |
| Repository: | CRAN |
| Date/Publication: | 2024-05-04 06:30:03 UTC |
Generate Random Given and Surnames
Description
Functions for generating random gender and ethnicity correct first and/or last names where names are proportionally sampled based upon their frequency ina large scale database.
Details
| Package: | randomNames |
| Type: | Package |
| Version: | 1.6-0.0 |
| Date: | 2024-5-2 |
| License: | GPL-3 |
| LazyLoad: | yes |
Author(s)
Damian W. BetebennerDBetebenner@nciea.org
Random Names Function
Description
Function to generate random gender and ethnicity correct first and/or last names. Names are chosen proportionally based upon their probability of appearing in a large scale database of real names.Function to generate random gender and ethnicity correct first and/or/last names. The function probabilistically samples from the embedded randomNamesData dataset to provide a realistic list offirst and/or last names.
Usage
randomNames(n, gender, ethnicity, which.names="both", name.order="last.first", name.sep=", ", sample.with.replacement=TRUE, return.complete.data=FALSE)Arguments
n | OPTIONAL. Positive integer indicating how many name to produce. Best to use when no gender or ethnicity data is provided and one simply wants |
gender | OPTIONAL. A vector indicating the genders for the names to be calculated. The maximum of |
ethnicity | OPTIONAL. A vector indicating the ethnicities for the names to be calculated. The maximum of
|
which.names | OPTIONAL. One of |
name.order | OPTIONAL. If |
name.sep | OPTIONAL. If |
sample.with.replacement | Boolean argument (defaults to TRUE) indicating whether sampling is done with replacement. |
return.complete.data | Boolean argument (defaults to FALSE) indicating whether to return data including gender and ethnicity codes used for name construct. If set to TRUE,data is returned as a data.frame/data.table. |
Details
Typical use of the function is to submit a vector of genders and ethnicities to derived a gender and ethnicity representative vector of first and/or last names.
Value
Function returns a character vector containing first and/or last names.
Author(s)
Damian W. Betebennerdbetebenner@nciea.org
See Also
Examples
randomNames() ## Returns a single name in "last, first" formatrandomNames(5, which.names="first") ## Returns 5 first namesrandomNames(5, return.complete.data=TRUE) ## Returns entire data.tabletest.df <- data.frame(GENDER=sample(0:1, 100, replace=TRUE),ETHNICITY=sample(1:6, 100, replace=TRUE))test.names <- randomNames(gender=test.df$GENDER,ethnicity=test.df$ETHNICITY)head(test.names)ethnicities <- c("African American", "Hispanic", "Asian", "White", "Native American")genders <- c("Female", "Male")test.df <- data.frame(GENDER=sample(genders, 100, replace=TRUE),ETHNICITY=sample(ethnicities, 100, replace=TRUE))test.names <- randomNames(gender=test.df$GENDER,ethnicity=test.df$ETHNICITY)head(test.names)First names (by gender and ethnicity) and last names (by ethnicity) for randomNames function
Description
A dataset compiled from a large scale data set of names providing first names by gender and ethnicity and last names by ethnicity. The dataset providesfrequency probabilities from the original data set so that sampling provides a reasonable set of random names. The dataset is for use with therandomNames function to quickly generate random names that can be used, for example, to anonymize results.
Format
An environment of first and last names by gender and ethnicity (first names) and ethnicity (last names)Gender is coded 0 for male and 1 for female, ethnicity is coded 1 for American Indian or Native Alaskan,2 for Asian or Pacific Islander, 3 for Black (not Hispanic), 4 for Hispanic, and 5 for White (notHispanic). For example, the arrayfirst_names_e1_g0 inrandomNamesData provides firstand associated frequency probabilities for male, American Indians or Native Alaskans. To view names ofall environment arrays typels(randomNamesData) after loading the package.
Source
Large scale state data