report: Fetch EDA of a specific type of column

Description Usage Arguments Details Examples

Description

Returns table with summary statistics of X's numeric|text|factor variables (based on results from examine(X))

Usage

1
2
3
4
5
report_num(res, group = "")

report_txt(res, group = "")

report_fct(res, group = "")

Arguments

res

A list returned from examine()

group

Group from which to retrieve summary (see vignette("doctr_examine") for more information)

Details

This function uses the result of examine()'s execution to generate a report on a table's numeric|text|factor variables; it is also able to retrieve the results from only one group given that examine() was used with its group argument

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
library(tidyverse)
  
# Getting EDA for numeric and text variables
txhousing %>% examine() %>% report_num()
txhousing %>% examine() %>% report_txt()
  
# Getting EDA with grouping (of a factor variable)
txhousing %>%
  mutate(city = as.factor(city)) %>%
  examine(1) %>%
  report_fct("Austin")

## End(Not run)

doctr documentation built on May 4, 2017, 5:11 p.m.

Related to report in doctr...