FrontMatter: R Front Matter

View source: R/FrontMatter.R

FrontMatterR Documentation

R Front Matter

Description

This function is used to create a string of information regarding the R/Rstudio version and R package details used for an analysis for printing in documents. The returned string includes newline characters so requires cat() to display properly.

Usage

FrontMatter(packages = NULL, rstudio = NULL)

Arguments

packages

Vector of packages we want to display. Default is NULL saying we don't want to return any package information. Otherwise it can be "all" to display information for all packages loaded.

rstudio

String specifying Rstudio version used. Default is NULL.

Value

A string with the front matter information. By default returns R version and time.

Author(s)

Richard T Gray, Rgray@kirby.unsw.edu.au

Examples

FrontMatter()
FrontMatter("ggplot2")
FrontMatter(packages = "all", rstudio = "1.1.423")


leftygray/LeftysRpkg documentation built on Feb. 11, 2024, 5:13 p.m.