Clean error messages & documentation following deprecations

R/cite.r

@@ -4,7 +4,7 @@ cite <- function(x, ...) UseMethod("cite")
 #' @rdname cite
 #' @title Citation for a survey
 #'
-#' @description Gets a full citation for a [survey()]. If quiet is FALSE (default)
+#' @description Gets a full citation for a [survey()].
 #'
 #' @param x a character vector of surveys to cite
 #' @param ... ignored
@@ -27,15 +27,17 @@ cite.survey <- function(x, ...) {
 
 #' @title Citation for a survey
 #'
-#' @description Gets a full citation for a [survey()]. If quiet is FALSE (default)
+#' @description Gets a full citation for a [survey()].
 #'
 #' @param x a character vector of surveys to cite
 #' @return citation as bibentry
 #' @importFrom utils bibentry
 #' @importFrom httr GET content
 #' @examples
 #' data(polymod)
-#' get_citation(polymod)
+#' citation <- get_citation(polymod)
+#' print(citation)
+#' print(citation, style = "bibtex")
 #' @export
 get_citation <- function(x) {
 

R/contact_matrix.r

@@ -64,7 +64,7 @@ contact_matrix <- function(survey, countries = NULL, survey.pop, age.limits, fil
   if (!missing(n)) {
     warning(
       "The 'n' option is being deprecated and will be removed ",
-      "following version 0.2.0. Please see the ",
+      "in version 1.0.0. Please see the ",
       "'Bootstrapping' section in the vignette for an ",
       "alternative approach."
     )
@@ -73,7 +73,7 @@ contact_matrix <- function(survey, countries = NULL, survey.pop, age.limits, fil
   if (!missing(bootstrap)) {
     warning(
       "The 'bootstrap' option is being deprecated and will be removed ",
-      "following version 0.2.0. Please use the 'sample.participants'",
+      "in version 1.0.0. Please use the 'sample.participants'",
       " option instead."
     )
     if (missing(sample.participants)) sample.participants <- bootstrap

R/get_survey.r

@@ -28,7 +28,7 @@ get_survey <- function(survey, ...) {
   if (!is.null(new_survey$reference)) {
     message(
       "Using ", new_survey$reference$title,
-      ". To cite this in a publication, use the 'cite' function"
+      ". To cite this in a publication, use the 'get_citation()' function"
     )
   }
 

R/load_survey.r

@@ -149,7 +149,7 @@ load_survey <- function(files, ...) {
   if (!is.null(new_survey$reference)) {
     message(
       "Using ", new_survey$reference$title,
-      ". To cite this in a publication, use the 'cite' function"
+      ". To cite this in a publication, use the 'get_citation()' function"
     )
   }