A Header forR Documentation

File simple.R

Description

Provide a simple example of a file using roxygen and standard R comments.

Warning

DO NOT CHANGE THE FOLLWOWING THREE LINES.

Note

This header will show up in the documentation, but it's got nothing to do with the R statements below. Usually this is not intended.

R: a first function example XXX
a_first_functionR Documentation

a first function example XXX

Description

This really is just an example, the function prints utils::head() and utils::str() of the given data.frame.

Usage

a_first_function(df)

Arguments

df

Name of a data.frame to ... do whatever needs to be done.

Value

NULL. This is no good.

Examples

data(iris, package = "datasets")
a_first_function(iris)