report (version 0.1.0)

report.data.frame: Dataframe Report

Description

Create a report of a dataframe.

Usage

# S3 method for data.frame
report(
  model,
  median = FALSE,
  centrality = TRUE,
  dispersion = TRUE,
  range = TRUE,
  distribution = FALSE,
  levels_percentage = FALSE,
  n_characters = 3,
  missing_percentage = FALSE,
  ...
)
# S3 method for character
report(
  model,
  n_characters = 3,
  levels_percentage = FALSE,
  missing_percentage = FALSE,
  ...
)
# S3 method for factor
report(model, levels_percentage = FALSE, ...)
# S3 method for numeric
report(
  model,
  median = FALSE,
  centrality = TRUE,
  dispersion = TRUE,
  range = TRUE,
  distribution = FALSE,
  missing_percentage = FALSE,
  ...
)

Arguments

model

A data.frame or a vector.

median

Show mean and sd (default) or median and mad.

centrality

Show index of centrality (mean or median).

dispersion

Show index of dispersion (sd or mad).

range

Show range.

distribution

Returns Kurtosis and Skewness in table.

levels_percentage

Show characters entries and factor levels by number (default) or percentage.

n_characters

Number of different character entries to show. Can be "all".

missing_percentage

Show missings by number (default) or percentage.

...

Arguments passed to or from other methods.

See Also

report

report

report

report

Examples

# NOT RUN {
library(report)

report(iris)
r <- report(iris, median = TRUE, dispersion = FALSE, distribution = TRUE, missing_percentage = TRUE)
to_fulltext(r)
to_table(r)
to_fulltable(r)
x <- c("A", "B", "C", "A", "B", "B", "D", "E", "B", "D", "A")
report(x)
report(x, n_characters = 2, levels_percentage = TRUE, missing_percentage = TRUE)
to_fulltext(report(x))
to_table(report(x, n_characters = "all"))
to_fulltable(report(x))
x <- factor(rep(c("A", "B", "C"), 10))
report(x)
report(x, levels_percentage = TRUE, missing_percentage = TRUE)
to_fulltext(report(x))
to_table(report(x))
to_fulltable(report(x))
# }
# NOT RUN {
x <- rnorm(1000)
report(x)
report(x, median = TRUE, missing_percentage = TRUE, distribution = TRUE)
to_fulltext(report(x))
to_table(report(x))
to_fulltable(report(x))
# }