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 @@

Damian W Betebenner

-

2017-06-20

+

2017-06-23

@@ -100,11 +100,11 @@

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"
+> [1] "Jones Jr, Sammy"

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"
+> [1] "Stebbins, Nhi" "Lamas, Diana" "el-Bacchus, Katheer" +> [4] "Hernandez, Jesus" "Thesz, Steven"

Additional output control

@@ -124,16 +124,17 @@

Examples

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"
+> [1] "Leslie, Sierra" "Simmons, Arturo" +> [3] "Williams Martin, Nicole" "Kleinman, Christopher" +> [5] "el-Hallal, Haazim"

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"
+> [1] "Saenz, Corey" "Milender, Michael" "Kim, Jessica" +> [4] "Cunningham, Aimee" "Roubal, Annelise"

The third argument, ethnicity, controls the ethnicity of the names returned. The following integer codes/ethnicities are accepted:

  1. American Indian or Native Alaskan
  2. @@ -144,19 +145,19 @@

  3. Middle-Eastern, Arabic
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"
+> [1] "Aggers, Payton" "Cross, Turmon" "Savage Jr, Rajon" +> [4] "Reid, Dalvin" "Nelson, Desmond"

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"
+> [1] "Tawfeeqa" "Noora" "Nawaal" "Labeeba" "Tayyiba"

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"
+> [1] "Jaleela, al-Hasan" "Madeeha, el-Parsa" "Taamira, el-Mona" +> [4] "Musfira, al-Sadek" "Iffat, el-Noori"

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"
+> [1] "Shahaama al-Lone" "Ghaaliba el-Sattar" " Huda al-Popal" +> [4] "Jumaima al-Jabbar" "Khaalida al-Wali"
diff --git a/docs/index.html b/docs/index.html index 49612d1..c6e4617 100644 --- a/docs/index.html +++ b/docs/index.html @@ -155,8 +155,8 @@

License

GPL-3

Links

diff --git a/docs/news/index.html b/docs/news/index.html index 710b810..8c0ef60 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -107,8 +107,7 @@

Change log All releases

randomNames 1.0-0.0