dat4rox: roxygen2 Format Data Sets

Description Usage Arguments Examples

View source: R/dat4rox.R

Description

This function generates basic roxygen framework for data sets that can be set to print to your package's main .R file.

Usage

1

Arguments

file

A connection, or a character string naming the file to print to. If "" (the default), dat4rox prints to the standard output connection, the console.

append

append logical. Only used if the argument file is the name of file (and not a connection or "|cmd"). If TRUE output will be appended to file; otherwise, it will overwrite the contents of file. This allows for appnding to the main package .R file.

...

Package datasets.

Examples

1
2
3
4
5
6
7
## Not run: 
dat4rox(mtcars, CO2)                   #print only to console
dat4rox(mtcars, CO2, file = "new.txt") #print to new file
#print to package.R file
#dat4rox(mtcars, CO2, file = "qdap-package.R", append = TRUE)

## End(Not run)

trinker/acc.roxygen2 documentation built on May 27, 2017, 1:45 p.m.