makeReadMe: Makes a basic readme to go with model archive.

In USGS-R/modelArchive: Aids in creating and reviewing model archives for USGS R models.

Description

The makeReadMe function generates a basic readme file describing the model and model archive directory structure

Usage

makeReadMe(modelTitle = "", modelAuthor = "", modelContact = "",
  modelDescription = "", modelPurpose = "", modelRunProcedure = "",
  supInfo = "", filePath = "modelArchive")

Arguments

modelTitle	String describing the model. Line breaks can be included by splitting the description into a character vector, where each line cooresponds to an entry in the vector.
modelAuthor	String describing the model. Line breaks can be included by splitting the description into a character vector, where each line cooresponds to an entry in the vector.
modelContact	String describing the model. Line breaks can be included by splitting the description into a character vector, where each line cooresponds to an entry in the vector.
modelDescription	String describing the model. Line breaks can be included by splitting the description into a character vector, where each line cooresponds to an entry in the vector.
modelPurpose	String describing the model. Line breaks can be included by splitting the description into a character vector, where each line cooresponds to an entry in the vector.
modelRunProcedure	String describing the model. Line breaks can be included by splitting the description into a character vector, where each line cooresponds to an entry in the vector.
filePath	Relative file path of folder cooresponding to model archive folder.

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