From 86be6553be8a51e0bc923ca05cf150522101344a Mon Sep 17 00:00:00 2001 From: dbetebenner Date: Tue, 20 Jun 2017 08:49:08 -0400 Subject: [PATCH 1/4] Changing label for link --- _pkgdown.yml | 4 ++-- docs/articles/randomNames.html | 35 ++++++++++++++++++---------------- docs/index.html | 2 +- 3 files changed, 22 insertions(+), 19 deletions(-) diff --git a/_pkgdown.yml b/_pkgdown.yml index 72ba42b..321f86d 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: diff --git a/docs/articles/randomNames.html b/docs/articles/randomNames.html index c1cac87..5c0d5c1 100644 --- a/docs/articles/randomNames.html +++ b/docs/articles/randomNames.html @@ -100,11 +100,12 @@

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] "Martin, Michael"
+> [1] "Mitchell, Almiranda"

To generate more random names, just supply a positive integer to the randomNames function:

randomNames(5)
-> [1] "Lawrence, Brandi"   "Kumagai, Kalisha"   "Liu, Breanna-Marie"
-> [4] "Ruiz, Areli"        "Warren, Emonie"
+> [1] "el-Mohammadi, Fateena" "Lee, Billy" +> [3] "Windom, Shannon" "Malievsky, Chelsea" +> [5] "Ryersonmerredith, Troy"

Additional output control

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

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] "Meda Zamora, Mallory" "Williamsnash, Brian" +> [3] "Gonzalez-Trejo, Jonathan" "Mckoy, Dominic" +> [5] "Mortel, Young"

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] "Lee, Janelle"   "Lu, Sophia"     "Tran, Samantha" "Scott, Lauren" 
+> [5] "Bradley, Jonae"
 
 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] "Norton, Cody" "Colunga, Orion" "Villa, Jennifer" +> [4] "Bordeaux, Brittany" "al-Anwar, Aaida"

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 +146,20 @@

  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] "Smith-Johnson, Jonathan" "Waddles, Omari" +> [3] "Farrell, Adam" "Lane, Antonio" +> [5] "Parks, Shaquille"

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] "Saamiqa" "Raafida" "Jawhara" "Reema" "Raita"

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] "Izza, al-Rassi" "Zuhra, al-Arshad" "Mahaa, al-Abdo" +> [4] "Nazeeha, al-Agha" "Kulthum, al-Salik"

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] "Jumaana el-Kaiser" "Sundus el-Khalifa" "Qaaida el-Chahine" +> [4] "Shaakira el-Zamani" "Kaazima al-Hannan"
diff --git a/docs/index.html b/docs/index.html index 3d08b84..9c378aa 100644 --- a/docs/index.html +++ b/docs/index.html @@ -158,7 +158,7 @@

Links

  • Download from CRAN
  • Browse source code
  • Report an issue
    • -
  • Learn more
    • +
  • Other Center stuff

    • Dev status

      From f7cc376e2b118b5912b5a2167862cec36ce1dca2 Mon Sep 17 00:00:00 2001 From: dbetebenner Date: Tue, 20 Jun 2017 21:50:58 -0400 Subject: [PATCH 2/4] Update of randomNames docs and moving appveyor to .appveyor --- NEWS.md | 3 +- _pkgdown.yml | 6 +- appveyor.yml | 45 ------- docs/articles/index.html | 6 +- docs/articles/randomNames.html | 41 +++--- docs/articles/releases/randomNames-0.0-1.html | 6 +- .../releases/randomNames-1.0-0.0.html | 10 +- docs/articles/releases/randomNames-1.0-0.html | 121 ------------------ docs/authors.html | 6 +- docs/index.html | 6 +- docs/news/index.html | 6 +- docs/reference/index.html | 6 +- docs/reference/randomNames-package.html | 6 +- docs/reference/randomNames.html | 6 +- docs/reference/randomNamesData.html | 6 +- inst/doc/randomNames.html | 36 +++--- vignettes/releases/randomNames-1.0-0.0.Rmd | 6 +- 17 files changed, 76 insertions(+), 246 deletions(-) delete mode 100644 appveyor.yml delete mode 100644 docs/articles/releases/randomNames-1.0-0.html 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 321f86d..9934923 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -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/appveyor.yml b/appveyor.yml deleted file mode 100644 index c6c1438..0000000 --- a/appveyor.yml +++ /dev/null @@ -1,45 +0,0 @@ -# DO NOT CHANGE the "init" and "install" sections below - -# Download script file from GitHub -init: - ps: | - $ErrorActionPreference = "Stop" - Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1" - Import-Module '..\appveyor-tool.ps1' - -install: - ps: Bootstrap - -cache: - - C:\RLibrary - -# Adapt as necessary starting from here - -build_script: - - travis-tool.sh install_deps - -test_script: - - travis-tool.sh run_tests - -on_failure: - - 7z a failure.zip *.Rcheck\* - - appveyor PushArtifact failure.zip - -artifacts: - - path: '*.Rcheck\**\*.log' - name: Logs - - - path: '*.Rcheck\**\*.out' - name: Logs - - - path: '*.Rcheck\**\*.fail' - name: Logs - - - path: '*.Rcheck\**\*.Rout' - name: Logs - - - path: '\*_*.tar.gz' - name: Bits - - - path: '\*_*.zip' - name: Bits 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

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

      Examples

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

      randomNames(5) ## 5 last, first names
-> [1] "Meda Zamora, Mallory"     "Williamsnash, Brian"     
-> [3] "Gonzalez-Trejo, Jonathan" "Mckoy, Dominic"          
-> [5] "Mortel, Young"
      +> [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] "Lee, Janelle"   "Lu, Sophia"     "Tran, Samantha" "Scott, Lauren" 
-> [5] "Bradley, Jonae"
+> [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] "Norton, Cody"       "Colunga, Orion"     "Villa, Jennifer"   
-> [4] "Bordeaux, Brittany" "al-Anwar, Aaida"
      +> [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. @@ -146,20 +144,19 @@

    2. Middle-Eastern, Arabic

    randomNames(5, gender=0, ethnicity=3) ## 5 African American, male last, first names
-> [1] "Smith-Johnson, Jonathan" "Waddles, Omari"         
-> [3] "Farrell, Adam"           "Lane, Antonio"          
-> [5] "Parks, Shaquille"
    +> [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] "Saamiqa" "Raafida" "Jawhara" "Reema"   "Raita"
    +> [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] "Izza, al-Rassi"    "Zuhra, al-Arshad"  "Mahaa, al-Abdo"   
-> [4] "Nazeeha, al-Agha"  "Kulthum, al-Salik"
    +> [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] "Jumaana el-Kaiser"  "Sundus el-Khalifa"  "Qaaida el-Chahine" 
-> [4] "Shaakira el-Zamani" "Kaazima al-Hannan"
    +> [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! From 61099087abd3fe6b881725106552a545fb7d5951 Mon Sep 17 00:00:00 2001 From: dbetebenner Date: Tue, 20 Jun 2017 21:52:58 -0400 Subject: [PATCH 3/4] Moving appveyor to .appveyor --- .appveyor.yml | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .appveyor.yml diff --git a/.appveyor.yml b/.appveyor.yml new file mode 100644 index 0000000..c6c1438 --- /dev/null +++ b/.appveyor.yml @@ -0,0 +1,45 @@ +# DO NOT CHANGE the "init" and "install" sections below + +# Download script file from GitHub +init: + ps: | + $ErrorActionPreference = "Stop" + Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1" + Import-Module '..\appveyor-tool.ps1' + +install: + ps: Bootstrap + +cache: + - C:\RLibrary + +# Adapt as necessary starting from here + +build_script: + - travis-tool.sh install_deps + +test_script: + - travis-tool.sh run_tests + +on_failure: + - 7z a failure.zip *.Rcheck\* + - appveyor PushArtifact failure.zip + +artifacts: + - path: '*.Rcheck\**\*.log' + name: Logs + + - path: '*.Rcheck\**\*.out' + name: Logs + + - path: '*.Rcheck\**\*.fail' + name: Logs + + - path: '*.Rcheck\**\*.Rout' + name: Logs + + - path: '\*_*.tar.gz' + name: Bits + + - path: '\*_*.zip' + name: Bits From 82564426745327b094b88f4e90501be035b030f0 Mon Sep 17 00:00:00 2001 From: dbetebenner Date: Tue, 20 Jun 2017 21:53:48 -0400 Subject: [PATCH 4/4] Updating Rbuildignore --- .Rbuildignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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$