help_console: Print help to console

In EvolEcolGroup/pastclim: Manipulate Time Series of Palaeoclimate Reconstructions

Print help to console

Description

This function prints a help file to console. It is based on a function published on R-bloggers: from https://www.r-bloggers.com/2013/06/printing-r-help-files-in-the-console-or-in-knitr-documents/

Usage

help_console(
  topic,
  format = c("text", "html", "latex"),
  lines = NULL,
  before = NULL,
  after = NULL
)

Arguments

topic	The topic of the help
format	how the output should be formatted
lines	which lines should be printed
before	string to be printed before the output
after	string to be printed after the output

Value

text of the help file

EvolEcolGroup/pastclim documentation built on Nov. 8, 2024, 5:21 a.m.