rReview: Create distribution and frequency data for each column of a...

Description Usage Arguments Value See Also

View source: R/rc_rReview.R

Description

Create distribution and frequency data for each column of a data frame and produce a dataReviewR object containing details of the frequency of variables and summary stats for each column of the data. See vignette("dataReviewR") for more details.

Usage

1
rReview(df, roundDigits = NA, trimChars = FALSE, clean_var_names = TRUE)

Arguments

df

data frame. The data object. dataReviewR will attempt to coerce all data objects to data frames.

roundDigits

Integer. If NA, numerics are not rounded before comparison. If specified, numerics are rounded to the specified number of decimal places using round.

trimChars

Boolean. If true, strings and factors have whitespace trimmed before comparison.

clean_var_names

User defined boolean indicating whether to clean the variable names using janitor::clean_names, DEFAULT = T

Value

An dataReviewR object. An S3 object containing details of the comparison between the two data objects. Can be used with summary, print and saveReport

See Also

Other dataReviewR.functions: saveReport(), summary.dataReviewRobject()


eauleaf/dataReviewR documentation built on Dec. 20, 2021, 3:11 a.m.