prepComment: prepComment

View source: R/prepComment.R

prepCommentR Documentation

prepComment

Description

Helper function to properly format a metadata comment entry

Usage

prepComment(x, name, warning = NULL)

Arguments

x

content to be added as metadata comment

name

Name of the metadata entry

warning

Either NULL (no warning) or a warning text that should be returned if x is NULL

Author(s)

Jan Philipp Dietrich

Examples

 madrat:::prepComment("example comment", "example")

madrat documentation built on April 4, 2025, 5:41 a.m.