prepExtendedComment: prepExtendedComment

View source: R/prepExtendedComment.R

prepExtendedCommentR Documentation

prepExtendedComment

Description

Helper function condense metadata information into an extended comment entry

Usage

prepExtendedComment(x, type, functionCallString, warn = TRUE)

Arguments

x

list containing the metadata to be condensed

type

output type, e.g. "TauTotal"

functionCallString

A string representation of the function call that created the object this comment is attached to

warn

boolean indicating whether warnings should be triggered if entries are missing, or not.

Author(s)

Jan Philipp Dietrich, Pascal Sauer


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