Merge branch 'release/v1.3.7' into master

k3jph · Oct 1, 2020 · 28f1148 · 28f1148
2 parents 1c746f0 + 9494d7c
commit 28f1148
Show file tree

Hide file tree

Showing 16 changed files with 89 additions and 17 deletions.
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -1,6 +1,6 @@
 on:
   push:
-    branches: develop
+    branches: master
 
 name: pkgdown
 

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: phonics
 Type: Package
 Title: Phonetic Spelling Algorithms
-Version: 1.3.6
+Version: 1.3.7
 Date: 2020-07-05
 Encoding: UTF-8
 Authors@R: c(person(given = "James", family = "Howard",
@@ -13,7 +13,8 @@ Authors@R: c(person(given = "James", family = "Howard",
 URL: https://jameshoward.us/phonics-in-r/
 BugReports: https://github.com/k3jph/phonics-in-r/issues
 Description: Provides a collection of phonetic algorithms including
-    Soundex, Metaphone, NYSIIS, Caverphone, and others.
+    Soundex, Metaphone, NYSIIS, Caverphone, and others.  The package is
+    documented in <doi:10.18637/jss.v095.i08>.
 License: BSD_2_clause + file LICENSE
 LazyData: TRUE
 Imports:
@@ -26,5 +27,5 @@ Suggests:
     devtools
 LinkingTo: Rcpp,
     BH
-RoxygenNote: 7.1.0
+RoxygenNote: 7.1.1
 VignetteBuilder: knitr
diff --git a/R/caverphone.R b/R/caverphone.R
@@ -63,6 +63,10 @@
 #' David Hood, "Caverphone Revisited," Technical Paper CTP150804
 #' University of Otago, New Zealand, 2004.
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' @family phonics
 #'
 #' @examples

diff --git a/R/cologne.R b/R/cologne.R
@@ -54,6 +54,10 @@
 #'
 #' @references
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' Hans Joachim Postel. "Die Koelner Phonetik. Ein Verfahren zur
 #' Identifizierung von Personennamen auf der Grundlage der
 #' Gestaltanalyse."  \emph{IBM-Nachrichten} 19. Jahrgang, 1969,

diff --git a/R/lein.R b/R/lein.R
@@ -53,6 +53,10 @@
 #'
 #' @references
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' Billy T. Lynch and William L. Arends. "Selection of surname coding
 #' procedure for the SRS record linkage system." United States
 #' Department of Agriculture, Sample Survey Research Branch, Research

diff --git a/R/metaphone.R b/R/metaphone.R
@@ -63,6 +63,12 @@
 #' @return a character vector containing the metaphones of \code{word},
 #' or an NA if the \code{word} value is NA
 #'
+#' @references
+#'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' @family phonics
 #'
 #' @examples

diff --git a/R/mra.R b/R/mra.R
@@ -60,6 +60,10 @@
 #'
 #' @references
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' G.B. Moore, J.L. Kuhns, J.L. Treffzs, and C.A. Montgomery,
 #' \emph{Accessing Individual Records from Personal Data Files Using
 #' Nonunique Identifiers,} US National Institute of Standards and
@@ -72,7 +76,6 @@
 #' mra_encode(c("Peter", "Peady"))
 #' mra_encode("Stevenson")
 
-#' @rdname mra
 #' @name mra_encode
 #' @export
 mra_encode <- function(word, clean = TRUE) {

diff --git a/R/nysiis.R b/R/nysiis.R
@@ -60,6 +60,10 @@
 #'
 #' @references
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' Robert L. Taft, \emph{Name search techniques}, Bureau of Systems
 #' Development, Albany, New York, 1970.
 #'

diff --git a/R/onca.R b/R/onca.R
@@ -57,6 +57,10 @@
 #'
 #' Gill, Leicester. "OX-LINK: the Oxford medical record linkage system." (1997).
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' @family phonics
 #'
 #' @examples

diff --git a/R/phonex.R b/R/phonex.R
@@ -54,6 +54,10 @@
 #'
 #' @references
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' A.J. Lait and Brian Randell. "An assessment of name matching
 #' algorithms." Technical Report Series-University of Newcastle Upon
 #' Tyne Computing Science (1996).

diff --git a/R/phonics.R b/R/phonics.R
@@ -77,6 +77,12 @@
 #' Returns a data frame containing the phonetic spellings of the input
 #' for each method applied.
 #'
+#' @references
+#'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' @family phonics
 #'
 #' @examples

diff --git a/R/rogerroot.R b/R/rogerroot.R
@@ -56,6 +56,10 @@
 #'
 #' @references
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' Robert L. Taft, \emph{Name search techniques}, Bureau of Systems
 #' Development, Albany, New York, 1970.
 #'

diff --git a/R/soundex.R b/R/soundex.R
@@ -63,10 +63,15 @@
 #' "A-Z." For inputs outside this range, the output is undefined.
 #'
 #' @references
+#'
 #' Charles P. Bourne and Donald F. Ford, "A study of methods for
 #' systematically abbreviating English words and names," \emph{Journal
 #' of the ACM}, vol. 8, no. 4 (1961), p. 538-552.
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' Howard B. Newcombe, James M. Kennedy, "Record linkage: making
 #' maximum use of the discriminating power of identifying information,"
 #' \emph{Communications of the ACM}, vol. 5, no. 11 (1962), p. 563-566.

diff --git a/R/statcan.R b/R/statcan.R
@@ -53,6 +53,10 @@
 #'
 #' @references
 #'
+#' James P. Howard, II, "Phonetic Spelling Algorithm Implementations
+#' for R," \emph{Journal of Statistical Software}, vol. 25, no. 8,
+#' (2020), p. 1--21, <10.18637/jss.v095.i08>.
+#'
 #' Billy T. Lynch and William L. Arends. "Selection of surname coding
 #' procedure for the SRS record linkage system." United States
 #' Department of Agriculture, Sample Survey Research Branch, Research

diff --git a/inst/CITATION b/inst/CITATION
@@ -1,21 +1,40 @@
 year <- sub("-.*", "", meta$Date)
 note <- sprintf("R package version %s", meta$Version)
 
-bibentry(bibtype = "Manual",
-         title = "{phonics}: Phonetic Spelling Algorithms in R",
-         author = "James P. Howard",
-         year = year,
-         note = note,
-         doi = "10.5281/zenodo.1041982",
-         url = "https://jameshoward.us/phonics-in-r/")
 
 bibentry(bibtype = "Article",
-         title = "Phonetic Algorithms in R",
-         author = "James P. Howard",
+  title        = "Phonetic Spelling Algorithm Implementations for {R}",
+  author       = c(person(given = c("James", "P."),
+                          family = "Howard, II",
+                          email = "[email protected]")),
+  journal      = "Journal of Statistical Software",
+  year         = "2020",
+  volume       = "95",
+  number       = "8",
+  pages        = "1--21",
+  doi          = "10.18637/jss.v095.i08",
+
+  header       = "To cite phonics in publications use:"
+)
+
+bibentry(bibtype = "Article",
+         title = "Phonetic Algorithms in {R}",
+         author       = c(person(given = c("James", "P."),
+                          family = "Howard, II",
+                          email = "[email protected]")),
          year = "2018",
          journal = "Journal of Open Source Software",
          volume = "3",
          number = "22",
          pages = "480",
-         doi = "10.21105/joss.00480",
-         url = "https://joss.theoj.org/papers/10.21105/joss.00480")
+         doi = "10.21105/joss.00480")
+
+bibentry(bibtype = "Manual",
+         title = "{phonics}: Phonetic Spelling Algorithms in R",
+         author       = c(person(given = c("James", "P."),
+                          family = "Howard, II",
+                          email = "[email protected]")),
+         year = year,
+         note = note,
+         doi = "10.5281/zenodo.1041982",
+         url = "https://jameshoward.us/phonics-in-r/")
diff --git a/vignettes/phonics.Rmd b/vignettes/phonics.Rmd
@@ -1,5 +1,5 @@
 ---
-title: "Overview of the ``phonics`` Package"
+title: "Overview of the phonics Package"
 author: "James P. Howard, II"
 date: "`r Sys.Date()`"
 output: rmarkdown::html_vignette