f_summarize: Give basic info on columns in data frame

View source: R/f - Summarize.R

f_summarizeR Documentation

Give basic info on columns in data frame

Description

Gives basic info on columns in data frame.

Usage

f_summarize(
  df.input,
  b.sort = TRUE,
  b.view = TRUE,
  b.write = FALSE,
  b.return = FALSE,
  n.char = "all",
  n.freq = 3
)

Arguments

df.input

Data frame to summarize.

b.sort

Should items be sorted? (default: TRUE).

b.view

Should we display the result? (default: TRUE).

b.write

Should we write the summary table to XLS? (default: FALSE).

b.return

Should we return the resulting data frame (default: FALSE).

n.char

Number of characters to show of each item (default: "all").

n.freq

Number of items to show (default: 3).

Details

-

Value

Data frame summarizing the data in df.input, in case b.return is TRUE.

Author(s)

Pieter Overdevest

Examples

f_summarize(

     df.input = mtcars,
     b.sort   = TRUE,
     b.view   = TRUE,
     b.write  = FALSE,
     b.return = FALSE,
     n.char   = "all",
     n.freq   = 3
)

pieterov/generaltoolbox documentation built on Jan. 25, 2025, 10:32 a.m.