summarize_metrics: Summarize metrics with common descriptors

View source: R/summarize_metrics.R

summarize_metricsR Documentation

Summarize metrics with common descriptors

Description

\Sexpr[results=rd, stage=render]{lifecycle::badge("experimental")}

Summarizes all numeric columns. Counts the NAs and Infs in the columns.

Usage

summarize_metrics(data, cols = NULL, na.rm = TRUE, inf.rm = TRUE)

Arguments

data

data.frame with numeric columns to summarize.

cols

Names of columns to summarize. Non-numeric columns are ignored. (Character)

na.rm

Whether to remove NAs before summarizing. (Logical)

inf.rm

Whether to remove Infs before summarizing. (Logical)

Value

tibble where each row is a descriptor of the column.

The Measure column contains the name of the descriptor.

The NAs row is a count of the NAs in the column.

The INFs row is a count of the Infs in the column.

Author(s)

Ludvig Renbo Olsen, r-pkgs@ludvigolsen.dk

Examples

# Attach packages
library(cvms)
library(dplyr)

df <- data.frame("a" = c("a", "a", "a", "b", "b", "b", "c", "c", "c"),
                 "b" = c(0.8, 0.6, 0.3, 0.2, 0.4, 0.5, 0.8, 0.1, 0.5),
                 "c" = c(0.2, 0.3, 0.4, 0.6, 0.5, 0.8, 0.1, 0.8, 0.3))

# Summarize all numeric columns
summarize_metrics(df)

# Summarize column "b"
summarize_metrics(df, cols = "b")

cvms documentation built on Sept. 11, 2024, 6:22 p.m.