dataDoc: Checks basic files and documentation in model archive.

Description Usage Arguments Examples

Description

The checkArchive function checks that all files are documented in the readme and that each folder contains files.

Usage

1
dataDoc(dataFrame, fileName = NULL, type = "ascii")

Arguments

dataFrame

Data.frame object to document

type

type of text file formatting, can either by "ascii" for an ascii table or "tab" for tab delimited

file

Filename of text file to contain output, should be the same name as datafile being described with no extension. If left NULL output prints to console.

Examples

1
dataDoc(dataFrame = iris)

USGS-R/modelArchive documentation built on May 9, 2019, 8:38 p.m.