added example

git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8462 1feff8c3-07ed-0310-ac33-dd36852eb9cd
This commit is contained in:
Scott R Charlton 2014-02-07 07:05:22 +00:00
parent b295df937d
commit ec36df6d33

View File

@ -5,7 +5,7 @@
Clears the accumulated input buffer. Clears the accumulated input buffer.
} }
\description{ \description{
%% ~~ A concise (1-5 lines) description of what the function does. ~~ Clears the accumulated input buffer. The input buffer is accumulated from calls to the \code{\link{phrAccumulateLine}} method.
} }
\usage{ \usage{
phrClearAccumulatedLines() phrClearAccumulatedLines()
@ -15,17 +15,14 @@ phrClearAccumulatedLines()
%% ~~ If necessary, more details than the description above ~~ %% ~~ If necessary, more details than the description above ~~
} }
\value{ \value{
%% ~Describe the value returned This function returns NULL.
%% If it is a LIST, use
%% \item{comp1 }{Description of 'comp1'}
%% \item{comp2 }{Description of 'comp2'}
%% ...
} }
\references{ \references{
%% ~put references to the literature/web site here ~ \url{http://wwwbrr.cr.usgs.gov/projects/GWC_coupled/phreeqc}
} }
\author{ \author{
%% ~~who you are~~ David Parkhurst \email{dlpark@usgs.gov}\cr
Maintainer: Scott Charlton \email{charlton@usgs.gov}
} }
\note{ \note{
%% ~~further notes~~ %% ~~further notes~~
@ -34,17 +31,16 @@ phrClearAccumulatedLines()
%% ~Make other sections like Warning with \section{Warning }{....} ~ %% ~Make other sections like Warning with \section{Warning }{....} ~
\seealso{ \seealso{
%% ~~objects to See Also as \code{\link{help}}, ~~~ \code{\link{phrAccumulateLine}}, \code{\link{phrGetAccumulatedLines}}, \code{\link{phrRunAccumulated}}
} }
\examples{ \examples{
##---- Should be DIRECTLY executable !! ---- # This example loads some keyword input, clears the input, and displays the results.
##-- ==> Define data, use random, phrAccumulateLine("SOLUTION 1")
##-- or do help(data=index) for the standard data sets. phrAccumulateLine("END")
cat(paste("The accumulated input is:\n", phrGetAccumulatedLines(), sep=""))
## The function is currently defined as phrClearAccumulatedLines()
function () WScript.Echo("The accumulated input now is:\n" + phrLines)
{ cat(paste("The accumulated input now is:\n", phrGetAccumulatedLines(), sep=""))
}
} }
% Add one or more standard keywords, see file 'KEYWORDS' in the % Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory. % R documentation directory.