From fc9f2b41481b50cdecfd792e756b9e2d44154548 Mon Sep 17 00:00:00 2001 From: Scott R Charlton Date: Thu, 6 Feb 2014 07:02:45 +0000 Subject: [PATCH] added files from package.skeleton(name="phreeqc") git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8450 1feff8c3-07ed-0310-ac33-dd36852eb9cd --- R/phreeqc/man/PHREEQC_DAT.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrAccumulateLine.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrClearAccumulatedLines.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetAccumulatedLines.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetComponentList.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetDumpFileName.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetDumpString.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetErrorFileName.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetErrorFileOn.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetLogFileName.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetLogString.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetOutputFileName.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetOutputString.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetSelectedOutputFileName.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetSelectedOutputString.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrGetWarningString.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrLoadDatabaseString.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrRunAccumulated.Rd | 52 +++++++++++++++++ R/phreeqc/man/phrRunString.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetDumpFileName.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetDumpFileOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetDumpStringOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetErrorFileName.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetErrorFileOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetErrorStringOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetLogFileName.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetLogFileOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetLogStringOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetOutputFileName.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetOutputFileOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetOutputStringOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetSelectedOutputFileName.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetSelectedOutputFileOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phrSetSelectedOutputStringOn.Rd | 57 +++++++++++++++++++ R/phreeqc/man/phreeqc-package.Rd | 41 +++++++++++++ 35 files changed, 1899 insertions(+) create mode 100644 R/phreeqc/man/PHREEQC_DAT.Rd create mode 100644 R/phreeqc/man/phrAccumulateLine.Rd create mode 100644 R/phreeqc/man/phrClearAccumulatedLines.Rd create mode 100644 R/phreeqc/man/phrGetAccumulatedLines.Rd create mode 100644 R/phreeqc/man/phrGetComponentList.Rd create mode 100644 R/phreeqc/man/phrGetDumpFileName.Rd create mode 100644 R/phreeqc/man/phrGetDumpString.Rd create mode 100644 R/phreeqc/man/phrGetErrorFileName.Rd create mode 100644 R/phreeqc/man/phrGetErrorFileOn.Rd create mode 100644 R/phreeqc/man/phrGetLogFileName.Rd create mode 100644 R/phreeqc/man/phrGetLogString.Rd create mode 100644 R/phreeqc/man/phrGetOutputFileName.Rd create mode 100644 R/phreeqc/man/phrGetOutputString.Rd create mode 100644 R/phreeqc/man/phrGetSelectedOutputFileName.Rd create mode 100644 R/phreeqc/man/phrGetSelectedOutputString.Rd create mode 100644 R/phreeqc/man/phrGetWarningString.Rd create mode 100644 R/phreeqc/man/phrLoadDatabaseString.Rd create mode 100644 R/phreeqc/man/phrRunAccumulated.Rd create mode 100644 R/phreeqc/man/phrRunString.Rd create mode 100644 R/phreeqc/man/phrSetDumpFileName.Rd create mode 100644 R/phreeqc/man/phrSetDumpFileOn.Rd create mode 100644 R/phreeqc/man/phrSetDumpStringOn.Rd create mode 100644 R/phreeqc/man/phrSetErrorFileName.Rd create mode 100644 R/phreeqc/man/phrSetErrorFileOn.Rd create mode 100644 R/phreeqc/man/phrSetErrorStringOn.Rd create mode 100644 R/phreeqc/man/phrSetLogFileName.Rd create mode 100644 R/phreeqc/man/phrSetLogFileOn.Rd create mode 100644 R/phreeqc/man/phrSetLogStringOn.Rd create mode 100644 R/phreeqc/man/phrSetOutputFileName.Rd create mode 100644 R/phreeqc/man/phrSetOutputFileOn.Rd create mode 100644 R/phreeqc/man/phrSetOutputStringOn.Rd create mode 100644 R/phreeqc/man/phrSetSelectedOutputFileName.Rd create mode 100644 R/phreeqc/man/phrSetSelectedOutputFileOn.Rd create mode 100644 R/phreeqc/man/phrSetSelectedOutputStringOn.Rd create mode 100644 R/phreeqc/man/phreeqc-package.Rd diff --git a/R/phreeqc/man/PHREEQC_DAT.Rd b/R/phreeqc/man/PHREEQC_DAT.Rd new file mode 100644 index 00000000..0c19bd1a --- /dev/null +++ b/R/phreeqc/man/PHREEQC_DAT.Rd @@ -0,0 +1,52 @@ +\name{PHREEQC_DAT} +\alias{PHREEQC_DAT} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +PHREEQC_DAT() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrAccumulateLine.Rd b/R/phreeqc/man/phrAccumulateLine.Rd new file mode 100644 index 00000000..fd0541bd --- /dev/null +++ b/R/phreeqc/man/phrAccumulateLine.Rd @@ -0,0 +1,57 @@ +\name{phrAccumulateLine} +\alias{phrAccumulateLine} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrAccumulateLine(line) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{line}{ +%% ~~Describe \code{line} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (line) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrClearAccumulatedLines.Rd b/R/phreeqc/man/phrClearAccumulatedLines.Rd new file mode 100644 index 00000000..5540480f --- /dev/null +++ b/R/phreeqc/man/phrClearAccumulatedLines.Rd @@ -0,0 +1,52 @@ +\name{phrClearAccumulatedLines} +\alias{phrClearAccumulatedLines} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrClearAccumulatedLines() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetAccumulatedLines.Rd b/R/phreeqc/man/phrGetAccumulatedLines.Rd new file mode 100644 index 00000000..8edb90be --- /dev/null +++ b/R/phreeqc/man/phrGetAccumulatedLines.Rd @@ -0,0 +1,52 @@ +\name{phrGetAccumulatedLines} +\alias{phrGetAccumulatedLines} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetAccumulatedLines() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetComponentList.Rd b/R/phreeqc/man/phrGetComponentList.Rd new file mode 100644 index 00000000..1babc049 --- /dev/null +++ b/R/phreeqc/man/phrGetComponentList.Rd @@ -0,0 +1,52 @@ +\name{phrGetComponentList} +\alias{phrGetComponentList} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetComponentList() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetDumpFileName.Rd b/R/phreeqc/man/phrGetDumpFileName.Rd new file mode 100644 index 00000000..b7d2760a --- /dev/null +++ b/R/phreeqc/man/phrGetDumpFileName.Rd @@ -0,0 +1,52 @@ +\name{phrGetDumpFileName} +\alias{phrGetDumpFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetDumpFileName() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetDumpString.Rd b/R/phreeqc/man/phrGetDumpString.Rd new file mode 100644 index 00000000..8aec0c04 --- /dev/null +++ b/R/phreeqc/man/phrGetDumpString.Rd @@ -0,0 +1,52 @@ +\name{phrGetDumpString} +\alias{phrGetDumpString} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetDumpString() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetErrorFileName.Rd b/R/phreeqc/man/phrGetErrorFileName.Rd new file mode 100644 index 00000000..06262deb --- /dev/null +++ b/R/phreeqc/man/phrGetErrorFileName.Rd @@ -0,0 +1,52 @@ +\name{phrGetErrorFileName} +\alias{phrGetErrorFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetErrorFileName() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetErrorFileOn.Rd b/R/phreeqc/man/phrGetErrorFileOn.Rd new file mode 100644 index 00000000..803562c8 --- /dev/null +++ b/R/phreeqc/man/phrGetErrorFileOn.Rd @@ -0,0 +1,52 @@ +\name{phrGetErrorFileOn} +\alias{phrGetErrorFileOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetErrorFileOn() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetLogFileName.Rd b/R/phreeqc/man/phrGetLogFileName.Rd new file mode 100644 index 00000000..4a85ad37 --- /dev/null +++ b/R/phreeqc/man/phrGetLogFileName.Rd @@ -0,0 +1,52 @@ +\name{phrGetLogFileName} +\alias{phrGetLogFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetLogFileName() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetLogString.Rd b/R/phreeqc/man/phrGetLogString.Rd new file mode 100644 index 00000000..c325db62 --- /dev/null +++ b/R/phreeqc/man/phrGetLogString.Rd @@ -0,0 +1,52 @@ +\name{phrGetLogString} +\alias{phrGetLogString} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetLogString() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetOutputFileName.Rd b/R/phreeqc/man/phrGetOutputFileName.Rd new file mode 100644 index 00000000..03797ae5 --- /dev/null +++ b/R/phreeqc/man/phrGetOutputFileName.Rd @@ -0,0 +1,52 @@ +\name{phrGetOutputFileName} +\alias{phrGetOutputFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetOutputFileName() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetOutputString.Rd b/R/phreeqc/man/phrGetOutputString.Rd new file mode 100644 index 00000000..c244cebc --- /dev/null +++ b/R/phreeqc/man/phrGetOutputString.Rd @@ -0,0 +1,52 @@ +\name{phrGetOutputString} +\alias{phrGetOutputString} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetOutputString() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetSelectedOutputFileName.Rd b/R/phreeqc/man/phrGetSelectedOutputFileName.Rd new file mode 100644 index 00000000..acac9793 --- /dev/null +++ b/R/phreeqc/man/phrGetSelectedOutputFileName.Rd @@ -0,0 +1,52 @@ +\name{phrGetSelectedOutputFileName} +\alias{phrGetSelectedOutputFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetSelectedOutputFileName() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetSelectedOutputString.Rd b/R/phreeqc/man/phrGetSelectedOutputString.Rd new file mode 100644 index 00000000..da6bc970 --- /dev/null +++ b/R/phreeqc/man/phrGetSelectedOutputString.Rd @@ -0,0 +1,52 @@ +\name{phrGetSelectedOutputString} +\alias{phrGetSelectedOutputString} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetSelectedOutputString() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrGetWarningString.Rd b/R/phreeqc/man/phrGetWarningString.Rd new file mode 100644 index 00000000..c0c385b3 --- /dev/null +++ b/R/phreeqc/man/phrGetWarningString.Rd @@ -0,0 +1,52 @@ +\name{phrGetWarningString} +\alias{phrGetWarningString} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrGetWarningString() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrLoadDatabaseString.Rd b/R/phreeqc/man/phrLoadDatabaseString.Rd new file mode 100644 index 00000000..d2ead774 --- /dev/null +++ b/R/phreeqc/man/phrLoadDatabaseString.Rd @@ -0,0 +1,57 @@ +\name{phrLoadDatabaseString} +\alias{phrLoadDatabaseString} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrLoadDatabaseString(input) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{input}{ +%% ~~Describe \code{input} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (input) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrRunAccumulated.Rd b/R/phreeqc/man/phrRunAccumulated.Rd new file mode 100644 index 00000000..35682eea --- /dev/null +++ b/R/phreeqc/man/phrRunAccumulated.Rd @@ -0,0 +1,52 @@ +\name{phrRunAccumulated} +\alias{phrRunAccumulated} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrRunAccumulated() +} +%- maybe also 'usage' for other objects documented here. +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function () +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrRunString.Rd b/R/phreeqc/man/phrRunString.Rd new file mode 100644 index 00000000..d0612afe --- /dev/null +++ b/R/phreeqc/man/phrRunString.Rd @@ -0,0 +1,57 @@ +\name{phrRunString} +\alias{phrRunString} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrRunString(input) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{input}{ +%% ~~Describe \code{input} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (input) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetDumpFileName.Rd b/R/phreeqc/man/phrSetDumpFileName.Rd new file mode 100644 index 00000000..39b9b935 --- /dev/null +++ b/R/phreeqc/man/phrSetDumpFileName.Rd @@ -0,0 +1,57 @@ +\name{phrSetDumpFileName} +\alias{phrSetDumpFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetDumpFileName(filename) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{filename}{ +%% ~~Describe \code{filename} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (filename) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetDumpFileOn.Rd b/R/phreeqc/man/phrSetDumpFileOn.Rd new file mode 100644 index 00000000..68fd0d74 --- /dev/null +++ b/R/phreeqc/man/phrSetDumpFileOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetDumpFileOn} +\alias{phrSetDumpFileOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetDumpFileOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetDumpStringOn.Rd b/R/phreeqc/man/phrSetDumpStringOn.Rd new file mode 100644 index 00000000..344438a9 --- /dev/null +++ b/R/phreeqc/man/phrSetDumpStringOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetDumpStringOn} +\alias{phrSetDumpStringOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetDumpStringOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetErrorFileName.Rd b/R/phreeqc/man/phrSetErrorFileName.Rd new file mode 100644 index 00000000..8317634e --- /dev/null +++ b/R/phreeqc/man/phrSetErrorFileName.Rd @@ -0,0 +1,57 @@ +\name{phrSetErrorFileName} +\alias{phrSetErrorFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetErrorFileName(filename) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{filename}{ +%% ~~Describe \code{filename} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (filename) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetErrorFileOn.Rd b/R/phreeqc/man/phrSetErrorFileOn.Rd new file mode 100644 index 00000000..2dbb2df5 --- /dev/null +++ b/R/phreeqc/man/phrSetErrorFileOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetErrorFileOn} +\alias{phrSetErrorFileOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetErrorFileOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetErrorStringOn.Rd b/R/phreeqc/man/phrSetErrorStringOn.Rd new file mode 100644 index 00000000..0bffd721 --- /dev/null +++ b/R/phreeqc/man/phrSetErrorStringOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetErrorStringOn} +\alias{phrSetErrorStringOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetErrorStringOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetLogFileName.Rd b/R/phreeqc/man/phrSetLogFileName.Rd new file mode 100644 index 00000000..a1eccfc4 --- /dev/null +++ b/R/phreeqc/man/phrSetLogFileName.Rd @@ -0,0 +1,57 @@ +\name{phrSetLogFileName} +\alias{phrSetLogFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetLogFileName(filename) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{filename}{ +%% ~~Describe \code{filename} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (filename) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetLogFileOn.Rd b/R/phreeqc/man/phrSetLogFileOn.Rd new file mode 100644 index 00000000..0a514bc7 --- /dev/null +++ b/R/phreeqc/man/phrSetLogFileOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetLogFileOn} +\alias{phrSetLogFileOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetLogFileOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetLogStringOn.Rd b/R/phreeqc/man/phrSetLogStringOn.Rd new file mode 100644 index 00000000..a34e81cc --- /dev/null +++ b/R/phreeqc/man/phrSetLogStringOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetLogStringOn} +\alias{phrSetLogStringOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetLogStringOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetOutputFileName.Rd b/R/phreeqc/man/phrSetOutputFileName.Rd new file mode 100644 index 00000000..2d046066 --- /dev/null +++ b/R/phreeqc/man/phrSetOutputFileName.Rd @@ -0,0 +1,57 @@ +\name{phrSetOutputFileName} +\alias{phrSetOutputFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetOutputFileName(filename) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{filename}{ +%% ~~Describe \code{filename} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (filename) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetOutputFileOn.Rd b/R/phreeqc/man/phrSetOutputFileOn.Rd new file mode 100644 index 00000000..2a693f85 --- /dev/null +++ b/R/phreeqc/man/phrSetOutputFileOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetOutputFileOn} +\alias{phrSetOutputFileOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetOutputFileOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetOutputStringOn.Rd b/R/phreeqc/man/phrSetOutputStringOn.Rd new file mode 100644 index 00000000..4de5e702 --- /dev/null +++ b/R/phreeqc/man/phrSetOutputStringOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetOutputStringOn} +\alias{phrSetOutputStringOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetOutputStringOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetSelectedOutputFileName.Rd b/R/phreeqc/man/phrSetSelectedOutputFileName.Rd new file mode 100644 index 00000000..aada744a --- /dev/null +++ b/R/phreeqc/man/phrSetSelectedOutputFileName.Rd @@ -0,0 +1,57 @@ +\name{phrSetSelectedOutputFileName} +\alias{phrSetSelectedOutputFileName} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetSelectedOutputFileName(filename) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{filename}{ +%% ~~Describe \code{filename} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (filename) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetSelectedOutputFileOn.Rd b/R/phreeqc/man/phrSetSelectedOutputFileOn.Rd new file mode 100644 index 00000000..ce26f9d5 --- /dev/null +++ b/R/phreeqc/man/phrSetSelectedOutputFileOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetSelectedOutputFileOn} +\alias{phrSetSelectedOutputFileOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetSelectedOutputFileOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phrSetSelectedOutputStringOn.Rd b/R/phreeqc/man/phrSetSelectedOutputStringOn.Rd new file mode 100644 index 00000000..3c750f6f --- /dev/null +++ b/R/phreeqc/man/phrSetSelectedOutputStringOn.Rd @@ -0,0 +1,57 @@ +\name{phrSetSelectedOutputStringOn} +\alias{phrSetSelectedOutputStringOn} +%- Also NEED an '\alias' for EACH other topic documented here. +\title{ +%% ~~function to do ... ~~ +} +\description{ +%% ~~ A concise (1-5 lines) description of what the function does. ~~ +} +\usage{ +phrSetSelectedOutputStringOn(value) +} +%- maybe also 'usage' for other objects documented here. +\arguments{ + \item{value}{ +%% ~~Describe \code{value} here~~ +} +} +\details{ +%% ~~ If necessary, more details than the description above ~~ +} +\value{ +%% ~Describe the value returned +%% If it is a LIST, use +%% \item{comp1 }{Description of 'comp1'} +%% \item{comp2 }{Description of 'comp2'} +%% ... +} +\references{ +%% ~put references to the literature/web site here ~ +} +\author{ +%% ~~who you are~~ +} +\note{ +%% ~~further notes~~ +} + +%% ~Make other sections like Warning with \section{Warning }{....} ~ + +\seealso{ +%% ~~objects to See Also as \code{\link{help}}, ~~~ +} +\examples{ +##---- Should be DIRECTLY executable !! ---- +##-- ==> Define data, use random, +##-- or do help(data=index) for the standard data sets. + +## The function is currently defined as +function (value) +{ + } +} +% Add one or more standard keywords, see file 'KEYWORDS' in the +% R documentation directory. +\keyword{ ~kwd1 } +\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line diff --git a/R/phreeqc/man/phreeqc-package.Rd b/R/phreeqc/man/phreeqc-package.Rd new file mode 100644 index 00000000..62a24509 --- /dev/null +++ b/R/phreeqc/man/phreeqc-package.Rd @@ -0,0 +1,41 @@ +\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 +~~ 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[:-package]{}} ~~ +} +\examples{ +~~ simple examples of the most important functions ~~ +}