prop: Calculate Proportion of TRUE Values in a Logical Vector

In checkthat: Intuitive Unit Testing Tools for Data Manipulation

Calculate Proportion of TRUE Values in a Logical Vector

Description

This function calculates the proportion of TRUE values in a logical vector.

Usage

prop(logical_vec, na.rm = FALSE)

Arguments

logical_vec	A logical vector.
na.rm	Logical. Should missing values be removed before calculation? Behaves similar to base::mean, removing missing values from both the numerator and denominator of the proportion calculation.

Value

The proportion of TRUE values in the logical vector.

Examples

prop(c(TRUE, TRUE, FALSE, TRUE)) # Returns 0.75
prop(c(TRUE, FALSE, TRUE, FALSE, NA), na.rm = TRUE) # Returns 0.5

checkthat documentation built on Sept. 13, 2023, 1:06 a.m.