pty: Pepa tells you

View source: R/pty.R

ptyR Documentation

Pepa tells you

Description

Explain an R object in plain English if she knows about it.

Usage

pty(
  x,
  author = "International Potato Center",
  format = c("html", "word", "pdf")
)

Arguments

x

An R object.

author

Report author.

format

The output file format for the report, "html" by default. Other options are "word" and "pdf".

Details

It uses a set of templates to explain R objects in plain English. It aims to produce automatic reports for some standard statistical procedures, most of them included in the st4gi package.

Value

It returns an explanation about the selected R object.

Author(s)

Raul Eyzaguirre.

Examples

# Pepa tells you something about a data frame:
pty(pjpz09)

reyzaguirre/pepa documentation built on April 20, 2024, 3:50 a.m.