spelling, Rmarkdown --> R Markdown

dcomtois · Jul 20, 2021 · 1af8ba7 · 1af8ba7
1 parent 8ac15f8
commit 1af8ba7
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 2,912 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -16,3 +16,4 @@
 vignettes/*.R
 vignettes/*.html
 inst/includes/fig-align.tex
+^doc$
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,8 @@ TODO.txt
 tests/*
 img/ds*.png
 vignettes/*.R
+vignettes/vignette.css
 notes/
-vignettes/*.R
 inst/doc
+/doc/
+/Meta/
diff --git a/R/st_css.R b/R/st_css.R
@@ -1,7 +1,7 @@
 #' Include \strong{summarytools}' \emph{css} Into Active Document
 #'
 #' Generates the \emph{css} needed by \strong{summarytools} in 
-#' \emph{R Markdown} documents.
+#' \emph{R markdown} documents.
 #'
 #' @param main Logical. Include \emph{summarytools.css} file. \code{TRUE} by
 #'   default. Affects only \strong{summarytools} objects.
@@ -17,7 +17,7 @@
 #' @param \dots Character. Path to additional \emph{css} file(s) to include.
 #'
 #' @details Typically the function is called right after the initial setup chunk
-#'   of an \emph{R Markdown} document, in a chunk having options
+#'   of an \emph{R markdown} document, in a chunk having options
 #'   \code{echo=FALSE} and \code{results="asis"}.
 #'   
 #' @keywords utilities

diff --git a/R/view.R b/R/view.R
@@ -18,7 +18,7 @@
 #' 
 #' @details 
 #' Creates \emph{html} outputs and displays them in \emph{RStudio}'s viewer, in
-#' a browser, or renders the \emph{html} code in \emph{R Markdown} documents. 
+#' a browser, or renders the \emph{html} code in \emph{R markdown} documents. 
 #'
 #' For objects of class \dQuote{\emph{summarytools}}, this function is simply
 #' a wrapper around \code{\link{print.summarytools}} with

diff --git a/man/st_css.Rd b/man/st_css.Rd
diff --git a/man/view.Rd b/man/view.Rd
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
diff --git a/vignettes/Introduction.Rmd b/vignettes/Introduction.Rmd
@@ -7,9 +7,7 @@ output:
     fig_caption: false
     toc: true
     toc_depth: 1
-    css: 
-    - !expr system.file("rmarkdown/templates/html_vignette/resources/vignette.css", 
-                        package = "rmarkdown")
+    css: vignette.css
 vignette: >
   %\VignetteIndexEntry{Introduction to summarytools}
   %\VignetteEngine{knitr::rmarkdown}
@@ -21,7 +19,10 @@ vignette: >
 
 ```{r setup, include=FALSE}
 library(knitr)
-opts_chunk$set(comment = NA, prompt = FALSE, cache = FALSE, results = 'asis')
+opts_chunk$set(comment = NA,
+               prompt = FALSE,
+               cache = FALSE,
+               results = 'asis')
 library(kableExtra)
 library(summarytools)
 library(magrittr)

diff --git a/vignettes/Introduction.html b/vignettes/Introduction.html
diff --git a/vignettes/Recommendations-rmarkdown.Rmd b/vignettes/Recommendations-rmarkdown.Rmd
@@ -7,9 +7,7 @@ output:
     fig_caption: false
     toc: true
     toc_depth: 1
-    css: 
-    - !expr system.file("rmarkdown/templates/html_vignette/resources/vignette.css", 
-                        package = "rmarkdown")
+    css: vignette.css
 vignette: >
   %\VignetteIndexEntry{Recommendations for R Markdown}
   %\VignetteEngine{knitr::rmarkdown}
@@ -18,24 +16,25 @@ vignette: >
   %\VignetteDepends{kableExtra}
 ---
 
-```{r, include=FALSE}
+
+```{r setup, include=FALSE}
 library(knitr)
 opts_chunk$set(comment = NA, 
                prompt  = FALSE,
                cache   = FALSE,
                echo    = TRUE,
                results = 'asis')
 library(summarytools)
-```
-
-```{r, echo=FALSE}
 st_options(bootstrap.css     = FALSE,       # Already part of the theme so no need for it
            plain.ascii       = FALSE,       # One of the essential settings
            style             = "rmarkdown", # Idem.
            dfSummary.silent  = TRUE,        # Suppresses messages about temporary files
            footnote          = NA,          # Keeping the results minimalistic
            subtitle.emphasis = FALSE)       # For the vignette theme, this gives better results.
                                             # For other themes, using TRUE might be preferable.
+```
+
+```{r, echo=FALSE}
 st_css(main = TRUE, global = TRUE)
 ```
 
@@ -321,18 +320,27 @@ looks like this:
 # author: "Dominic Comtois"
 # date: "`r Sys.Date()`"
 # output: 
-#   rmarkdown::html_vignette: 
-#     css: 
-#     - !expr system.file("rmarkdown/templates/html_vignette/resources/vignette.css", package = "rmarkdown")
+#   html_document:
+#     fig_caption: false
+#     toc: true
+#     toc_depth: 1
+#     css: vignette.css
 # vignette: >
 #   %\VignetteIndexEntry{Recommendations for R Markdown}
 #   %\VignetteEngine{knitr::rmarkdown}
 #   %\VignetteEncoding{UTF-8}
+#   %\VignetteDepends{magrittr}
+#   %\VignetteDepends{kableExtra}
 # ---
 ```
 
-The following **summarytools global options** have been set. More of them can
-be useful, but this is a good starting point.
+The *vignette.css* file is copied from the installed **rmarkdown** package's
+*templates/html_vignette/resources* directory.
+
+The following **global options** for **summarytools** have been set. Other
+options might also be useful to optimize content, but this is a good place
+to start from.
+
 ```{r, eval=FALSE}
 st_options(bootstrap.css     = FALSE,       # Already part of the theme 
            plain.ascii       = FALSE,       # One of the essential settings