man-roxygen/assert.R

In NorwegianVeterinaryInstitute/NVIcheckmate: Extension of checkmate with argument checking adapted for NVIverse

# BSD 3-Clause License
# 
# Copyright (c) 2019, Michel Lang
# All rights reserved.
# 
# The file has been imported from https://gihub.com/mllg/checkmate/man-roxygen/ 
# Modifications
# - Square brackets are escaped
# - Includes argument comment
#' 
#' @param .var.name \[\code{character(1)}\]\cr
#'  Name of the checked object to print in error messages. Defaults to
#'  the heuristic implemented in \code{\link[checkmate]{vname}}.
#' @param comment \[\code{character(1)}\]\cr
#'  Extra information to be appended to the standard error message in assertions.
#' @param add \[\code{AssertCollection}\]\cr
#'  Collection to store assertions. See \code{\link[checkmate]{AssertCollection}}.