mask: Mask Text for Blind Review

View source: R/mask.R

maskR Documentation

Mask Text for Blind Review

Description

The YAML front matter tag mask determines whether the text is displayed or replaced by mask_message. The YAML tag can take the values yes or no.

Usage

mask(
  x,
  mask_message = "masked for blind review",
  hide = rmarkdown::metadata$mask
)

Arguments

x

Atomic character vector to be masked.

mask_message

Atomic character vector to mask x with when mask: yes, Default: 'masked for blind review'

hide

Logical, Default: rmarkdown::metadata$mask

Value

Character vector.

See Also

metadata

Examples

mask("this is masked", hide = TRUE)

revise documentation built on April 3, 2025, 11:47 p.m.