add \value in Rd files.

DESCRIPTION

@@ -2,7 +2,7 @@ Package: dlookr
 Type: Package
 Title: Tools for Data Diagnosis, Exploration, Transformation
 Version: 0.6.3
-Date: 2024-01-02
+Date: 2024-01-13
 Authors@R: c(
   person("Choonghyun", "Ryu",, "[email protected]", role = c("aut", "cre"))
   )

R/EDA.R

@@ -70,6 +70,8 @@ eda_report <- function(.data, ...) {
 #' @param browse logical. choose whether to output the report results to the browser.
 #' @param ... arguments to be passed to methods.
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @examples
 #' \donttest{
 #' if (FALSE) {

R/binning.R

@@ -301,6 +301,7 @@ print.bins <- function(x, ...) {
 #' @param base_family character. The name of the base font family to use 
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to methods, such as graphical parameters (see par).
+#' @return An object of gtable class.
 #' @seealso \code{\link{binning}}, \code{\link{print.bins}}, \code{\link{summary.bins}}.
 #' @examples
 #' # Generate data for the example
@@ -682,6 +683,7 @@ summary.optimal_bins <- function(object, ...) {
 #' This is useful when the x-axis labels are long and overlap. 
 #' The default is 0 to not rotate the label.
 #' @param ... further arguments to be passed from or to other methods.
+#' @return An object of gtable class.
 #' @seealso \code{\link{binning_by}}, \code{\link{summary.optimal_bins}}
 #' @examples
 #' \donttest{
@@ -1303,6 +1305,7 @@ summary.performance_bin <- function(object, ...) {
 #' @param base_family character. The name of the base font family to use 
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... further arguments to be passed from or to other methods.
+#' @return A ggplot2 object.
 #' @seealso \code{\link{performance_bin}}, \code{\link{summary.performance_bin}}, \code{\link{binning_by}}, 
 #' \code{\link{plot.optimal_bins}}.
 #' @examples
@@ -1553,6 +1556,7 @@ binning_rgr <- function(.data, y, x, min_perc_bins = 0.1, max_n_bins = 5, ordere
 #' @param base_family character. The name of the base font family to use 
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... further arguments to be passed from or to other methods.
+#' @return An object of gtable class.
 #' @seealso \code{\link{binning_rgr}}, \code{\link{summary.bins}}
 #' @examples
 #' \donttest{

R/compare.R

@@ -867,7 +867,7 @@ print.compare_numeric <- function(x, ...) {
 #'   \item 0 : always parallel to the axis [default],
 #'   \item 1 : always horizontal to the axis,
 #' }
-#'    
+#' @return NULL. This function just draws a plot.
 #' @seealso \code{\link{compare_category}}, \code{\link{print.compare_category}}, \code{\link{summary.compare_category}}.
 #' @examples
 #' \donttest{
@@ -1028,6 +1028,7 @@ plot.compare_category <- function(x, prompt = FALSE, na.rm = FALSE,
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to methods, such as graphical parameters (see par).
 #' However, it does not support.
+#' @return NULL. This function just draws a plot.
 #' @seealso \code{\link{compare_numeric}}, \code{\link{print.compare_numeric}}, \code{\link{summary.compare_numeric}}.
 #' @examples
 #' \donttest{

R/correlate.R

@@ -24,8 +24,10 @@ plot_correlate <- function(.data, ...) {
 #' This function is computed stats::cor() function by use = "pairwise.complete.obs" option for numerical variable.
 #' And support categorical variable with theil's U correlation coefficient and Cramer's V correlation coefficient.
 #'
-#' @section Correlation coefficient information:
-#' It returns data.frame with the following variables.:
+#' @return An object of correlate class.
+#' 
+#' @section correlate class:
+#' The correlate class inherits the tibble class and has the following variables.:
 #'
 #' \itemize{
 #' \item var1 : names of numerical variable
@@ -615,7 +617,7 @@ summary.correlate <- function(object, ...) {
 #' They support unquoting and splicing.
 #'
 #' See vignette("EDA") for an introduction to these concepts.
-#'
+#' @return a ggplot2 object.
 #' @seealso \code{\link{plot_correlate.tbl_dbi}}, \code{\link{plot_outlier.data.frame}}.
 #' @export
 #' @method plot_correlate data.frame
@@ -821,6 +823,7 @@ plot_correlate_group_impl <- function(df, vars, method, typographic, base_family
 #' @param base_family character. The name of the base font family to use 
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to methods, such as graphical parameters (see par).
+#' @return No return value. This function is called for its side effect, which is to produce a plot on the current graphics device.
 #' @seealso \code{\link{correlate}}, \code{\link{summary.correlate}}.
 #' @examples
 #' \donttest{

R/diagnose.R

@@ -1392,6 +1392,8 @@ diagnose_report <- function(.data, output_format, output_file, output_dir, ...)
 #' @param browse logical. choose whether to output the report results to the browser.
 #' @param ... arguments to be passed to methods.
 #'
+#' @return No return value. This function only generates a report.
+#' 
 #' @examples
 #' \donttest{
 #' if (FALSE) {

R/graphics.R

@@ -4,6 +4,8 @@
 #' Import google font to be used when drawing charts.
 #' 
 #' @param family character. font family name
+#' 
+#' @return No return value. This function just loads Google Fonts.
 #'
 #' @details
 #' When attaching the dlookr package, use "Roboto Condensed" and 

R/imputation.R

@@ -643,6 +643,7 @@ summary.imputation <- function(object, ...) {
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to methods, such as graphical parameters (see par).
 #' only applies when the model argument is TRUE, and is used for ... of the plot.lm() function.
+#' @return A ggplot2 object.
 #' @seealso \code{\link{imputate_na}}, \code{\link{imputate_outlier}}, \code{\link{summary.imputation}}.
 #' @examples
 #' \donttest{

R/overview.R

@@ -327,6 +327,7 @@ summary.overview <- function(object, html = FALSE, ...)  {
 #' @param base_family character. The name of the base font family to use 
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... further arguments to be passed from or to other methods.
+#' @return A ggplot2 object.
 #' @seealso \code{\link{overview}}, \code{\link{summary.overview}}.
 #' @examples
 #' \donttest{

R/report.R

@@ -100,6 +100,8 @@ eda_paged_report <- function(.data, ...) {
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to methods.
 #'
+#' @return No return value. This function only generates a report.
+#' 
 #' @examples
 #' \donttest{
 #' if (FALSE) {
@@ -351,6 +353,8 @@ diagnose_web_report.data.frame <- function(.data, output_file = NULL, output_dir
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to pagedown::chrome_print().
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{diagnose_paged_report.tbl_dbi}}.
 #' @examples
 #' \donttest{
@@ -652,6 +656,8 @@ diagnose_paged_report.data.frame <- function(.data, output_format = c("pdf", "ht
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to methods.
 #'
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{eda_web_report.tbl_dbi}}.
 #' @examples
 #' \donttest{
@@ -908,6 +914,8 @@ eda_web_report.data.frame <- function(.data, target = NULL, output_file = NULL,
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details) 
 #' @param ... arguments to be passed to pagedown::chrome_print().
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{eda_paged_report.tbl_dbi}}.
 #' @examples
 #' \donttest{
@@ -1170,6 +1178,8 @@ eda_paged_report.data.frame <- function(.data, target = NULL, output_format = c(
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to methods.
 #'
+#' @return No return value. This function only generates a report.
+#' 
 #' @examples
 #' \donttest{
 #' if (FALSE) {
@@ -1389,6 +1399,8 @@ transformation_web_report <- function(.data, target = NULL, output_file = NULL,
 #' for the visualization. If not specified, the font defined in dlookr is applied. (See details)
 #' @param ... arguments to be passed to pagedown::chrome_print().
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @examples
 #' \donttest{
 #' if (FALSE) {

R/report_tbl_dbi.R

@@ -73,6 +73,8 @@
 #' @param as_factor logical. whether to convert to factor when importing a character type variable from DBMS table into R.
 #' @param ... arguments to be passed to methods.
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{diagnose_web_report.data.frame}}.
 #' @examples
 #' \donttest{
@@ -238,6 +240,8 @@ diagnose_web_report.tbl_dbi <- function(.data, output_file = NULL, output_dir =
 #' @param as_factor logical. whether to convert to factor when importing a character type variable from DBMS table into R.
 #' @param ... arguments to be passed to pagedown::chrome_print().
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{diagnose_paged_report.data.frame}}.
 #' @examples
 #' \donttest{
@@ -395,6 +399,8 @@ diagnose_paged_report.tbl_dbi <- function(.data, output_format = c("pdf", "html"
 #' @param as_factor logical. whether to convert to factor when importing a character type variable from DBMS table into R.
 #' @param ... arguments to be passed to methods.
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{eda_web_report.data.frame}}.
 #' @examples
 #' \donttest{
@@ -546,6 +552,8 @@ eda_web_report.tbl_dbi <- function(.data, target = NULL, output_file = NULL,
 #' @param as_factor logical. whether to convert to factor when importing a character type variable from DBMS table into R.
 #' @param ... arguments to be passed to pagedown::chrome_print().
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{eda_paged_report.data.frame}}.
 #' @examples
 #' \donttest{

R/tbl_dbi.R

@@ -1630,6 +1630,8 @@ target_by.tbl_dbi <- function(.data, target, in_database = FALSE, collect_size =
 #' @param font_family character. font family name for figure in pdf.
 #' @param ... arguments to be passed to methods.
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{diagnose_report.data.frame}}.
 #' @examples
 #' \donttest{
@@ -1759,6 +1761,8 @@ diagnose_report.tbl_dbi <- function(.data, output_format = c("pdf", "html"),
 #' @param font_family character. font family name for figure in pdf.
 #' @param ... arguments to be passed to methods.
 #' 
+#' @return No return value. This function only generates a report.
+#' 
 #' @seealso \code{\link{eda_report.data.frame}}.
 #' @examples
 #' \donttest{