diff --git a/docs/articles/randomNames.html b/docs/articles/randomNames.html index e687ed1..6a2b1dc 100644 --- a/docs/articles/randomNames.html +++ b/docs/articles/randomNames.html @@ -83,7 +83,7 @@
After installing the package from either CRAN or GitHub, it’s simple to generate random names using the following simple instructions.
By default, the randomNames
function supplies a single random last and first name separated by a comma:
randomNames()
-> [1] "Wilson, Merhawit"
To generate more random names, just supply a positive integer to the randomNames
function:
randomNames(5)
-> [1] "Morales, Eric" "Chapa, Matthew" "al-Abdul, Arshad"
-> [4] "Flinn, Elaine" "el-Ozer, Rifqa"
The first argument, n
, controls the number of names returned by the randomNames function:
randomNames(5) ## 5 last, first names
-> [1] "Cook, Kyana" "Cone, Cody" "Seideman, Kyle"
-> [4] "Molina, Trenda" "Dillon III, Luis"
The second argument, gender
, controls the gender (0=male, 1=female) of the first names returned. This argument can be a vector up to the same length as the number of names requested.
randomNames(5, gender=1) ## 5 female last, first names
-> [1] "Davis, Kree" "Kenney, Zoe" "al-Farra, Juwairiya"
-> [4] "Bowden, America" "el-Zaman, Mubeena"
+> [1] "Moreno, Vanessa" "Wade, Alexsiss" "al-Farra, Nakheel"
+> [4] "Park, Melody" "Irvin, Heather"
randomNames(5, gender=c(0,0,1,1,1)) ## 2 male and 3 female last, first names
-> [1] "Rubio, Nicholas" "Ly, James" "Anderson, Taeler"
-> [4] "el-Guler, Raafida" "Blackhorse, Consuello"
The third argument, ethnicity
, controls the ethnicity of the names returned. The following integer codes/ethnicities are accepted:
randomNames(5, gender=0, ethnicity=3) ## 5 African American, male last, first names
-> [1] "Moore, Tyreik" "Batton, Marcus" "Patilla, Kenneth"
-> [4] "Tuggle, Kevin" "Hayes, Demetrius"
The fourth argument, which.names
controls which names are returned. The argument accepts the values: both
(the default), last
, first
, or complete.data
randomNames(5, gender=1, ethnicity=6, which.names="first") ## 5 Middle Eastern/Arabic, female first names
-> [1] "Humaira" "Fareeda" "Tawfeeqa" "Samraa" "Radwa"
The fifth argument, name.order
, controls the order in which the names are returned. The argument is only relevant if which.names=both
. The argument accepts the values: last.first
(the default) and first.last
.
randomNames(5, gender=1, ethnicity=6, name.order="first.last") ## 5 first last names
-> [1] "Haajara, el-Javid" "Arwa, al-Baig" "Radiyya, al-Khatib"
-> [4] "Faraah, al-Shareef" "Khairiya, al-Doud"
The sixth argument, name.sep
, is a character string that controls the separator used when both
names are returned. The default separator is ,
.
randomNames(5, gender=1, ethnicity=6, name.order="first.last", name.sep=" ") ## 5 first last names separated by a space
-> [1] "Shaamila el-Beshara" "Umaima el-Sadri" "Ahlaam el-Asmar"
-> [4] "Raita al-Shareef" "Saabira el-Ammar"