vec2prose: List in prose

View source: R/vec2prose.R

vec2proseR Documentation

List in prose

Description

Takes a vector and returns prose listing vector elements. Suitable for use in inline text in Rmarkdown.

Usage

vec2prose(x, oxford_comma = TRUE, na.rm = TRUE, warn = TRUE)

Arguments

x

character vector of length > 0 (after removing NAs if na.rm = TRUE)

oxford_comma

logical. If TRUE (default), output includes oxford comma.

na.rm

logical. If TRUE (Default), remove all NA from output.

warn

logical. If TRUE (Default), warn about NAs in x.

Value

character vector of length 1.

Examples

x <- c("dogs", "cats", "pigs")

vec2prose(x)
vec2prose(x, oxford_comma = FALSE)


WhiteJP/jpw documentation built on April 17, 2025, 5:47 a.m.