From 4b340640b43eb65aa4021f125af5b05e933d7179 Mon Sep 17 00:00:00 2001
From: Etienne Bacher <52219252+etiennebacher@users.noreply.github.com>
Date: Tue, 6 Jun 2023 13:18:21 +0200
Subject: [PATCH] add doc [skip ci]

---
 R/plot.dw_data_tabulate.R    | 13 ++++++++++++
 man/plot.dw_data_tabulate.Rd | 39 ++++++++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+)
 create mode 100644 man/plot.dw_data_tabulate.Rd

diff --git a/R/plot.dw_data_tabulate.R b/R/plot.dw_data_tabulate.R
index 9026bb984..3e71bfd0a 100644
--- a/R/plot.dw_data_tabulate.R
+++ b/R/plot.dw_data_tabulate.R
@@ -1,3 +1,14 @@
+#' Plot tabulated data.
+#'
+#' @param x Object created by `datawizard::data_tabulate()`.
+#' @param value_lab Boolean. Should values and percentages be displayed at the
+#'  top of each bar.
+#' @param remove_na Boolean. Should missing values be dropped?
+#' @param na_label The label given to missing values (only when
+#'  `remove_na = FALSE`).
+#' @param error_bar Boolean. Should error bars be displayed?
+#'
+#' @rdname plot.dw_data_tabulate
 #' @export
 
 plot.dw_data_tabulates <- function(x, value_lab = TRUE, remove_na = FALSE,
@@ -8,6 +19,8 @@ plot.dw_data_tabulates <- function(x, value_lab = TRUE, remove_na = FALSE,
   })
 }
 
+#' @rdname plot.dw_data_tabulate
+#'
 #' @export
 
 plot.dw_data_tabulate <- function(x, value_lab = TRUE, remove_na = FALSE,
diff --git a/man/plot.dw_data_tabulate.Rd b/man/plot.dw_data_tabulate.Rd
new file mode 100644
index 000000000..78f460450
--- /dev/null
+++ b/man/plot.dw_data_tabulate.Rd
@@ -0,0 +1,39 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plot.dw_data_tabulate.R
+\name{plot.dw_data_tabulates}
+\alias{plot.dw_data_tabulates}
+\alias{plot.dw_data_tabulate}
+\title{Plot tabulated data.}
+\usage{
+\method{plot}{dw_data_tabulates}(
+  x,
+  value_lab = TRUE,
+  remove_na = FALSE,
+  na_label = "(Missing)",
+  error_bar = TRUE
+)
+
+\method{plot}{dw_data_tabulate}(
+  x,
+  value_lab = TRUE,
+  remove_na = FALSE,
+  na_label = "(Missing)",
+  error_bar = TRUE
+)
+}
+\arguments{
+\item{x}{Object created by \code{datawizard::data_tabulate()}.}
+
+\item{value_lab}{Boolean. Should values and percentages be displayed at the
+top of each bar.}
+
+\item{remove_na}{Boolean. Should missing values be dropped?}
+
+\item{na_label}{The label given to missing values (only when
+\code{remove_na = FALSE}).}
+
+\item{error_bar}{Boolean. Should error bars be displayed?}
+}
+\description{
+Plot tabulated data.
+}