markdownify documentation

Author: beanumber

DESCRIPTION

@@ -1,5 +1,4 @@
 Package: mdsr
-Date: 2024-04-26
 Title: Complement to 'Modern Data Science with R'
 Version: 0.2.9
 Authors@R: c(
@@ -54,7 +53,8 @@ Suggests:
     sf,
     testthat,
     utf8
-RoxygenNote: 7.3.1
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.2
 Encoding: UTF-8
 URL: https://github.com/mdsr-book/mdsr
 BugReports: https://github.com/mdsr-book/mdsr/issues

R/BabynameDist.R

@@ -3,7 +3,7 @@ globalVariables(c("x", "lx", "ex", "year", "sex", "age_today", "alive_prob", "li
 #' Wrangle babynames data
 #' @import dplyr
 #' @export
-#' @return a \code{\link[dplyr]{tbl_df}} similar to \code{\link[babynames]{babynames}}
+#' @return a [tibble::tbl_df] similar to [babynames::babynames]
 #' with a column for the estimated number of people alive in 2014.
 #' @examples 
 #' 

R/NCI60.R

@@ -1,8 +1,10 @@
 #' Load the NCI60 data from GitHub
 #' @export
+#' @returns A [tibble::tbl_df]
 #' @examples 
 #' 
-#' \dontrun{
+#' \donttest{
+#' # The file is 5.0 MB
 #' NCI60 <- etl_NCI60()
 #' }
 

R/data.R

@@ -1,6 +1,11 @@
 #' Replacements for LaTeX macros
 #' @name macros
+#' @details
+#' These functions are used by the authors to write the book, and are not
+#' intended for users. 
+#' 
 #' @export
+#' @keywords internal
 #' @param x text to wrap in macro
 #' @param index add LaTeX indexing?
 #' @examples 
@@ -89,7 +94,7 @@ mdsr_person <- function(x, ...) {
 
 #' @rdname macros
 #' @export
-#' @param ... arguments passed to \code{\link{index_entry}}
+#' @param ... arguments passed to [index_entry()]
 #' @examples 
 #' vocab(x = "Big data", .f = tolower)
 vocab <- function(x, ...) {
@@ -101,7 +106,7 @@ vocab <- function(x, ...) {
 #' @rdname macros
 #' @param index_label the name of the index
 #' @param emph Display the LaTeX entry in italics
-#' @param .f function to apply to \code{\link{x}} during indexing
+#' @param .f function to apply to `x` during indexing
 #' @param alt alternate character string to use for indexing
 #' @export
 #' @examples 

R/macros.R

@@ -1,11 +1,11 @@
 #' src_scidb
 #' @description Connect to the scidb server on Amazon Web Services.
 #' @param dbname the name of the database to which you want to connect
-#' @param ... arguments passed to \code{\link[dbplyr]{src_dbi}} or \code{\link[DBI]{dbConnect}}
+#' @param ... arguments passed to [dbplyr::src_dbi()] or [DBI::dbConnect()]
 #' @details This is a public, read-only account. Any abuse will be considered a 
 #' hostile act. 
-#' @return For \code{\link{src_scidb}}, a \code{\link[dbplyr]{src_dbi}} object
-#' @seealso \code{\link[dbplyr]{src_dbi}}
+#' @return For [src_scidb()], a [dbplyr::src_dbi] object
+#' @seealso [dbplyr::src_dbi()]
 #' @export
 #' @examples 
 #' \dontrun{
@@ -19,8 +19,8 @@ src_scidb <- function(dbname, ...) {
 
 #' @rdname src_scidb
 #' @export
-#' @return For \code{\link{dbConnect_scidb}}, a \code{\link[RMariaDB]{MariaDBConnection-class}} object
-#' @seealso \code{\link[RMariaDB]{MariaDBConnection-class}}
+#' @return For [dbConnect_scidb()], a [RMariaDB::MariaDBConnection-class] object
+#' @seealso [RMariaDB::MariaDBConnection-class]
 #' @examples 
 #' \dontrun{
 #' db_air <- dbConnect_scidb("airlines")
@@ -43,9 +43,9 @@ dbConnect_scidb <- function(dbname, ...) {
 #' @rdname src_scidb
 #' @export
 #' 
-#' @return For \code{\link{mysql_scidb}}, a character vector of length 1 to be used
-#' as an \code{engine.ops} argument, or on the command line. 
-#' @seealso \code{\link[knitr]{opts_chunk}}
+#' @return For [mysql_scidb()], a character vector of length 1 to be used
+#' as an `engine.ops` argument, or on the command line. 
+#' @seealso [knitr::opts_chunk()]
 #' @examples 
 #' 
 #' if (require(knitr)) {

R/scidb.R

@@ -55,7 +55,7 @@ skim <- function(data, ...) {
 #' Custom table output
 #' @export
 #' @param x A data.frame
-#' @param ... arguments passed to \code{\link[kableExtra]{kbl}}
+#' @param ... arguments passed to [kableExtra::kbl()]
 #' @examples 
 #' mdsr_table(faithful)
 

R/themes.R

@@ -2,10 +2,8 @@
 #' @param map A leaflet map object
 #' @param path_to_img A path to the image file to save
 #' @param overwrite Do you want to clobber any existing file?
-#' @param vwidth see \code{\link[webshot2]{webshot}}
-#' @param vheight see \code{\link[webshot2]{webshot}}
-#' @param cliprect see \code{\link[webshot2]{webshot}}
-#' @param ... arguments passed to \code{\link[webshot2]{webshot}}
+#' @inheritParams webshot2::webshot
+#' @param ... arguments passed to [webshot2::webshot()]
 #' @export
 #' @return a path to a PNG file
 #' @examples