reportGraph: Report Graph

View source: R/reportGraph.R

reportGraphR Documentation

Report Graph

Description

Creates a report of any R object in a graph.

Usage

reportGraph(x, family = "Auto", size = 60 * par("csi"))

Arguments

x

any R object.

family

the font family to use in the report. See Details.

size

the size of the text, in points

Details

The value for family can be any valid font family for the device. In general "serif," "sans," "mono," and "USGS" are valid. The default, "Auto" selects "USGS" for character vectors, and "mono" for any other object.

Value

In contrast to other high-level graphics functions in the smwrGraphs package, this function returns nothing because nothing is expected to be added to the graph and nothing contributed to a possible explanation.

Note

The report is always placed in the upper left hand corner of the graph and is left justified. If the report is longer than the height of the graph or wider than the width of the graph, then the report is truncated.

Examples

## Not run: 
setGD()
reportGraph("Hello world!")
# For more details of reportGraph see
vignette(topic="GraphGallery", package="smwrGraphs")

## End(Not run)

USGS-R/smwrGraphs documentation built on Oct. 11, 2022, 6:11 a.m.