brf_describe: Get a briefing of a data frame

View source: R/describe.R

brf_describeR Documentation

Get a briefing of a data frame

Description

Get a briefing of a data frame

Usage

brf_describe(
  df,
  groupings = NULL,
  na.rm = F,
  output_filename = "briefing.html",
  output_dir = NULL
)

Arguments

df

the data frame to summarise

groupings

The columns to use as grouping variables as a character vector.

output_filename

The name of the .html report (default: "briefing.html")

output_dir

The folder where to put the report. (default: 'NULL') If set to 'NULL' the report will be put in the current working directory Otherwise this parameter will be passed to the 'output_dir' parameter of rmarkdown::render()


AdrienLeGuillou/briefr documentation built on Dec. 30, 2024, 8:50 a.m.