diff --git a/.Rbuildignore b/.Rbuildignore index 1480349..8159dca 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,5 +3,5 @@ ^_pkgdown\.yml$ ^README\.md$ ^LICENSE.md -^appveyor\.yml$ +^\.appveyor\.yml$ ^vignettes/releases$ diff --git a/appveyor.yml b/.appveyor.yml similarity index 100% rename from appveyor.yml rename to .appveyor.yml diff --git a/NEWS.md b/NEWS.md index eb7ca1b..afd6789 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,7 +1,6 @@ # randomNames 1.0-0.0 -* Changed numbering of releases from 3 to 4 digits. -* Created real vignette and fixed everything up for a nice 1.0-0.0 release. +* Rolling out the first 1.0 release with nice documentation. # randomNames 0.6-0 diff --git a/_pkgdown.yml b/_pkgdown.yml index 72ba42b..9934923 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -6,8 +6,8 @@ template: home: strip_header: true links: - - text: Learn more - href: https://centerforassessment.github.io/randomNames + - text: Other Center stuff + href: https://centerforassessment.github.io/ navbar: @@ -15,16 +15,16 @@ navbar: type: default left: - text: Getting Started - href: articles/randomNames.html + href: articles/toOrdinal.html - text: Reference href: reference/index.html - text: News menu: - text: "Release notes" - text: "Version 1.0-0.0" - href: articles/releases/randomNames-1.0-0.html + href: articles/releases/toOrdinal-1.0-0.0.html - text: "Version 0.0-1" - href: articles/releases/randomNames-0.0-1.html + href: articles/releases/toOrdinal-0.0-1.html - text: "------------------" - text: "Change log" href: news/index.html diff --git a/docs/articles/index.html b/docs/articles/index.html index aac9580..61661b6 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -50,7 +50,7 @@

Additional output control

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

Examples

The first argument, n, controls the number of names returned by the randomNames function:

randomNames(5) ## 5 last, first names
-> [1] "White, Jessica"   "Xiong, Lisa"      "Madrid, Juan"    
-> [4] "Gonzales, Jeremy" "Anaya, Matthew"
+> [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] "el-Ghaffari, Sameera" "Sanchez, Crystal"     "Tripathi, Van"       
-> [4] "Begay, Dlisa"         "al-Bashir, Nawfa"
+> [1] "Davis, Kree"         "Kenney, Zoe"         "al-Farra, Juwairiya"
+> [4] "Bowden, America"     "el-Zaman, Mubeena"
 
 randomNames(5, gender=c(0,0,1,1,1)) ## 2 male  and 3 female last, first names
-> [1] "Gendelman, Michael" "Martinez, Anthony"  "Toney, Jennifer"   
-> [4] "al-Kabir, Humaira"  "Lyons, Alicia"
+> [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:

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

  2. Middle-Eastern, Arabic

randomNames(5, gender=0, ethnicity=3) ## 5 African American, male last, first names
-> [1] "Scott, Andre"     "Brooks, Jordan"   "Lee, Jermaine"   
-> [4] "Johnson, Damonel" "Bekele, Dashaune"
+> [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] "Naadiya" "Izza"    "Ariyya"  "Najwa"   "Khaira"
+> [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] "Tamanna, al-Abdi"     "Intisaar, el-Waheed"  "Saahira, el-Muhammed"
-> [4] "Jeelaan, al-Mahdi"    "Masroora, el-Yasin"
+> [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] "Saamiqa al-Qazi"   "Maajida al-Vohra"  "Amniyya el-Saleem"
-> [4] "Rasheeqa el-Faraj" "Shahaada al-Shad"
+> [1] "Shaamila el-Beshara" "Umaima el-Sadri" "Ahlaam el-Asmar" +> [4] "Raita al-Shareef" "Saabira el-Ammar"
diff --git a/docs/articles/releases/randomNames-0.0-1.html b/docs/articles/releases/randomNames-0.0-1.html index 71e7dc6..eb0466c 100644 --- a/docs/articles/releases/randomNames-0.0-1.html +++ b/docs/articles/releases/randomNames-0.0-1.html @@ -31,7 +31,7 @@
diff --git a/vignettes/releases/randomNames-1.0-0.0.Rmd b/vignettes/releases/randomNames-1.0-0.0.Rmd index 6758903..b080402 100755 --- a/vignettes/releases/randomNames-1.0-0.0.Rmd +++ b/vignettes/releases/randomNames-1.0-0.0.Rmd @@ -9,7 +9,7 @@ knitr::opts_chunk$set(comment = "#>", collapse = TRUE) This is 1.0 release of the **randomNames** package. This release is mostly about the creation of vignettes and [web-documentation](https://CenterForAssessment.github.io/randomNames) for the package. However, the package now -also support Middle Eastern/Arab names. See the new [Getting Started Vignette](https://centerforassessment.github.io/randomNames/articles/randomNames.html) -for more information. +also support Middle Eastern/Arabic names. See the new +[Getting Started Vignette](https://centerforassessment.github.io/randomNames/articles/randomNames.html) for more information. -Feel free to drop me a line with any comments, feature requests, or ideas. And give us a Tweet using the Twitter button in the upper right! +Feel free to drop me a line with any comments, feature requests, or ideas. And give us a shout-out Tweet using the Twitter button in the upper right!