Merge pull request #710 from krlmlr/b-typo
Fix typo
diff --git a/DESCRIPTION b/DESCRIPTION
index f9231db..a0ff256 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -56,5 +56,5 @@
sparkline
VignetteBuilder: knitr
Encoding: UTF-8
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.0
Roxygen: list(markdown = TRUE)
diff --git a/NAMESPACE b/NAMESPACE
index 4affb08..e4e8249 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -42,6 +42,7 @@
export(save_kable)
export(scroll_box)
export(spec_angle)
+export(spec_barplot)
export(spec_boxplot)
export(spec_color)
export(spec_font_size)
diff --git a/man/header_separate.Rd b/man/header_separate.Rd
index 60a5d31..d2f69fb 100644
--- a/man/header_separate.Rd
+++ b/man/header_separate.Rd
@@ -4,7 +4,7 @@
\alias{header_separate}
\title{Separate table headers and add additional header rows based on grouping}
\usage{
-header_separate(kable_input, sep = "[^[:alnum:]]+")
+header_separate(kable_input, sep = "[^[:alnum:]]+", ...)
}
\arguments{
\item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified}
diff --git a/man/spec_barplot.Rd b/man/spec_barplot.Rd
new file mode 100644
index 0000000..7b11fdd
--- /dev/null
+++ b/man/spec_barplot.Rd
@@ -0,0 +1,80 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/mini_plots.R
+\name{spec_barplot}
+\alias{spec_barplot}
+\title{Helper functions to generate inline sparklines}
+\usage{
+spec_barplot(
+ x,
+ devwidth = 200,
+ devheight = 40,
+ res = 300,
+ beside = F,
+ horiz = F,
+ same_lim = TRUE,
+ lim = NULL,
+ xaxt = "n",
+ yaxt = "n",
+ ann = FALSE,
+ col = NULL,
+ border = NA,
+ dir = if (is_latex()) rmd_files_dir() else tempdir(),
+ file = NULL,
+ file_type = if (is_latex()) "pdf" else svglite::svglite,
+ ...
+)
+}
+\arguments{
+\item{x}{Vector of values or List of vectors of values.}
+
+\item{res}{The resolution of the plot. Default is 300.}
+
+\item{same_lim}{T/F. If x is a list of vectors, should all the plots be
+plotted in the same range? Default is True.}
+
+\item{lim}{Manually specify plotting range in the form of
+\code{c(0, 10)}.}
+
+\item{xaxt}{On/Off for xaxis text}
+
+\item{yaxt}{On/Off for yaxis text}
+
+\item{ann}{On/Off for annotations (titles and axis titles)}
+
+\item{col}{Color for the fill of the histogram bar/boxplot box.}
+
+\item{border}{Color for the border.}
+
+\item{dir}{Directory of where the images will be saved.}
+
+\item{file}{File name. If not provided, a random name will be used}
+
+\item{file_type}{Graphic device. Can be character (e.g., \code{"pdf"})
+or a graphics device function (\code{grDevices::pdf}). This defaults
+to \code{"pdf"} if the rendering is in LaTeX and \code{"svg"} otherwise.}
+
+\item{...}{extraparameters passing to boxplot}
+
+\item{width}{The width of the plot in pixel}
+
+\item{height}{The height of the plot in pixel}
+
+\item{add_label}{For boxplot. T/F to add labels for min, mean and max.}
+
+\item{label_digits}{If T for add_label, rounding digits for the label.
+Default is 2.}
+
+\item{boxlty}{Boxplot - box boarder type}
+
+\item{medcol}{Boxplot - median line color}
+
+\item{medlwd}{Boxplot - median line width}
+}
+\description{
+These functions helps you quickly generate sets of sparkline
+style plots using base R plotting system. Currently, we support histogram,
+boxplot, line, scatter, pointrange, barplot plots. You can use them together with
+\code{column_spec} to generate inline plot in tables. By default, this function
+will save images in a folder called "kableExtra" and return the address of
+the file.
+}