iphreeqc/R/phreeqc/man/phreeqc-package.Rd
Scott R Charlton 6f31050a70 added simple example
git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8457 1feff8c3-07ed-0310-ac33-dd36852eb9cd
2014-02-06 23:28:53 +00:00

46 lines
1.2 KiB
R

\name{phreeqc-package}
\alias{phreeqc-package}
\alias{phreeqc}
\docType{package}
\title{
What the package does (short line)
~~ package title ~~
}
\description{
More about what it does (maybe more than one line)
~~ A concise (1-5 lines) description of the package ~~
}
\details{
\tabular{ll}{
Package: \tab phreeqc\cr
Type: \tab Package\cr
Version: \tab 1.0\cr
Date: \tab 2014-02-05\cr
License: \tab What license is it under?\cr
}
~~ An overview of how to use the package, including the most important functions ~~
}
\author{
Who wrote it
Maintainer: Who to complain to <yourfault@somewhere.net>
~~ The author and/or maintainer of the package ~~
}
\references{
~~ Literature or other references for background information ~~
}
~~ Optionally other standard keywords, one per line, from file KEYWORDS in the R ~~
~~ documentation directory ~~
\keyword{ package }
\seealso{
~~ Optional links to other man pages, e.g. ~~
~~ \code{\link[<pkg>:<pkg>-package]{<pkg>}} ~~
}
\examples{
phrLoadDatabase("phreeqc/phreeqc.dat")
phrOutputFileOn(TRUE)
if (is.null(phrRunFile("ex1")) {
cat(paste("see ", phrGetOutputFileName(), ".\n", sep=""))
}
}