Package 'datareportR'

Title: Fast Data Summary Reports
Description: Generates an RMarkdown data report with two components: a summary of an input dataset and a diff of the dataset relative to an old version.
Authors: Bryant Cong [aut, cre], Alex Gordon [aut]
Maintainer: Bryant Cong <[email protected]>
License: MIT + file LICENSE
Version: 0.1.2
Built: 2026-05-18 08:54:30 UTC
Source: https://github.com/bryantco/datareportR

Help Index

Generate a fast data report

Description

Generate a fast data report

Usage

render_data_report(
  df_input,
  df_input_old = NULL,
  save_rmd_dir = NULL,
  save_report_dir = NULL,
  save_rmd_file = NULL,
  save_report_file = NULL,
  include_skim = TRUE,
  include_diffdf = TRUE,
  output_format = "html"
)

Arguments

df_input

data.frame or tibble. Input dataset to generate the summary report on.
df_input_old

data.frame or tibble. Old input dataset to call diffdf::diffdf() on.
save_rmd_dir

character. Path to save the .Rmd file to. Defaults to the current working directory. If NULL, does not save the report to disk.
save_report_dir

character. Path to save the report to. Defaults to the current working directory.
save_rmd_file

character. Path to save the .Rmd file to. Can be either a file name (e.g., "data_report") or a file path. If a file path is specified, it must be consistent with save_rmd_dir, if save_rmd_dir is specified. If there is no file extension in the file path, automatically appends the .Rmd extension.
save_report_file

character. Path to save the report to. Can be either a file name (e.g., "data_report") or a file path. If a file path is specified, it must be consistent with save_report_dir, if save_report_dir is specified. If there is no file extension in the file path, automatically appends an extension.
include_skim

boolean. TRUE to include the data summary with skimr::skim() in the report. FALSE to exclude.
include_diffdf

boolean. TRUE to include the data diff with diffdf::diffdf() in the report. FALSE to exclude. If df_input_old is not specified, automatically set to FALSE.
output_format

character. Output format of the data report. Defaults to "html." So far, only "pdf" and "html" are supported.

Value

An output RMarkdown report with the data summary.

Examples

set.seed(12345)
iris = datasets::iris
iris_permuted = iris
iris_permuted$Species <- sample(iris$Species)
render_data_report(
  df_input = iris,
  df_input_old = iris_permuted,
  save_rmd_dir = tempdir(),
  save_report_dir = tempdir(),
  include_skim = TRUE,
  include_diffdf = TRUE
)