Description Usage Arguments Value

View source: R/LG_explain_plot.R

This function gives information about the different plots created
by this package. It is used internally in the
`shiny`

-application, and it can also be used when a plot is
desired included in an article/presentation. In the latter case
the plot must first be saved to an object, and that object can then
be given to this function in the argument `.plot_details`

.
Note that the returned text is based on the information that the
saved plot-object has in the attribute named `details`

, and it
is thus of course possible to create customised presentations
directly based on the information found there.

1 2 | ```
LG_explain_plot(.plot_details, .mode = NULL, .digits_for_points = 2,
.digits_for_percentiles = 0)
``` |

`.plot_details` |
This can either be a saved plot created by this
package, or it can be the details-list directly. (The latter
alternative is included to simplify the use of this function
inside of the internal |

`.mode` |
Specify the mode that the result will be returned in.
Two modes are supported, "markdown" and "latex". The default
value |

`.digits_for_points` |
An integer that specifies the number of
decimals to include when presenting a point. The default value
is |

`.digits_for_percentiles` |
An integer that specifies the number
of decimals to include when presenting the percentiles (of the
standard normal distribution) that corresponds to the point.
The default value is |

The returned result will be a description of the plot in
`.plot_details`

, in the mode specified by `.mode`

.

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.