mirror of
https://git.gfz-potsdam.de/naaice/iphreeqc.git
synced 2025-12-16 16:44:49 +01:00
more methods finished
git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8426 1feff8c3-07ed-0310-ac33-dd36852eb9cd
This commit is contained in:
parent
a210ef875a
commit
668817a8d5
47
R/phreeqc/man/phrGetErrorString.Rd
Normal file
47
R/phreeqc/man/phrGetErrorString.Rd
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
\name{phrGetErrorString}
|
||||||
|
\alias{phrGetErrorString}
|
||||||
|
\title{
|
||||||
|
Return error string
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
|
||||||
|
phrGetErrorString executes a phreeqc run
|
||||||
|
}
|
||||||
|
\synopsis{
|
||||||
|
phrGetErrorString()
|
||||||
|
}
|
||||||
|
\usage{
|
||||||
|
phrGetErrorString()
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
} %END arguments
|
||||||
|
\details{
|
||||||
|
|
||||||
|
Any details about the operation of this function should go here.
|
||||||
|
} %END details
|
||||||
|
\value{
|
||||||
|
This function returns the errors that occured during the previous
|
||||||
|
phrReadDB, phrRun, phrRunFile call.
|
||||||
|
}
|
||||||
|
\references{
|
||||||
|
Literature references and web URLs can go here.
|
||||||
|
}
|
||||||
|
\author{
|
||||||
|
Scott Charlton <charlton@usgs.gov>
|
||||||
|
|
||||||
|
Lopaka(Rob) Lee <rclee@usgs.gov>
|
||||||
|
}
|
||||||
|
\seealso{
|
||||||
|
\code{\link{phrReadString}},
|
||||||
|
\code{\link{phrRun}},
|
||||||
|
\code{\link{phrRunFile}},
|
||||||
|
\code{\link{phrGetSelectedOutput}}
|
||||||
|
}
|
||||||
|
|
||||||
|
\examples{
|
||||||
|
# loaddatabase should fail
|
||||||
|
n <- try(phrLoadDatabase("missing.dat"), silent = TRUE)
|
||||||
|
# if n is non-NULL display error string
|
||||||
|
if (!is.null(n)) phrGetErrorString()
|
||||||
|
}
|
||||||
|
\keyword{interface}
|
||||||
44
R/phreeqc/man/phrGetSelectedOutput.Rd
Normal file
44
R/phreeqc/man/phrGetSelectedOutput.Rd
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
\name{phrGetSelectedOutput}
|
||||||
|
\alias{phrGetSelectedOutput}
|
||||||
|
\title{
|
||||||
|
Return the results of a phreeqc run.
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
phrGetSelectedOutput return the results of a phreeqc run specified
|
||||||
|
in the selected output block of a phreeqc input file.
|
||||||
|
|
||||||
|
}
|
||||||
|
\synopsis{
|
||||||
|
phrGetSelectedOutput()
|
||||||
|
}
|
||||||
|
\usage{
|
||||||
|
phrGetSelectedOutput()
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
} %END arguments
|
||||||
|
\details{
|
||||||
|
|
||||||
|
Any details about the operation of this function should go here.
|
||||||
|
|
||||||
|
} %END details
|
||||||
|
\value{
|
||||||
|
Returns a data frame containing ...
|
||||||
|
}
|
||||||
|
\references{
|
||||||
|
Literature references and web URLs can go here.
|
||||||
|
}
|
||||||
|
\author{
|
||||||
|
Scott Charlton <charlton@usgs.gov>
|
||||||
|
|
||||||
|
Lopaka(Rob) Lee <rclee@usgs.gov>
|
||||||
|
}
|
||||||
|
\seealso{
|
||||||
|
\code{\link{phrReadDB}},
|
||||||
|
\code{\link{phrReadString}},
|
||||||
|
\code{\link{phrRun}}
|
||||||
|
}
|
||||||
|
\examples{
|
||||||
|
|
||||||
|
# Simple example here
|
||||||
|
}
|
||||||
|
\keyword{interface}
|
||||||
47
R/phreeqc/man/phrLoadDatabase.Rd
Normal file
47
R/phreeqc/man/phrLoadDatabase.Rd
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
\name{phrLoadDatabase}
|
||||||
|
\alias{phrLoadDatabase}
|
||||||
|
\title{
|
||||||
|
Read phreeqc database file
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
|
||||||
|
phrLoadDatabase loads a phreeqc database file into ...
|
||||||
|
}
|
||||||
|
\synopsis{
|
||||||
|
phrLoadDatabase(filename)
|
||||||
|
}
|
||||||
|
\usage{
|
||||||
|
phrLoadDatabase(filename)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{filename}{
|
||||||
|
The file name of the database.
|
||||||
|
}
|
||||||
|
} %END arguments
|
||||||
|
\details{
|
||||||
|
|
||||||
|
Any details about the operation of this function should go here.
|
||||||
|
|
||||||
|
} %END details
|
||||||
|
\value{
|
||||||
|
This function returns NULL.
|
||||||
|
}
|
||||||
|
\references{
|
||||||
|
Literature references and web URLs can go here.
|
||||||
|
}
|
||||||
|
\author{
|
||||||
|
Scott Charlton <charlton@usgs.gov>
|
||||||
|
|
||||||
|
}
|
||||||
|
\seealso{
|
||||||
|
\code{\link{phrReadString}},
|
||||||
|
\code{\link{phrRun}},
|
||||||
|
\code{\link{phrGetSelectedOutput}}
|
||||||
|
}
|
||||||
|
|
||||||
|
\examples{
|
||||||
|
|
||||||
|
# This will only work if phreeqc.dat is in the current directory
|
||||||
|
phrLoadDatabase("phreeqc/phreeqc.dat")
|
||||||
|
}
|
||||||
|
\keyword{interface}
|
||||||
48
R/phreeqc/man/phrRunFile.Rd
Normal file
48
R/phreeqc/man/phrRunFile.Rd
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
\name{phrRunFile}
|
||||||
|
\alias{phrRunFile}
|
||||||
|
\title{
|
||||||
|
Run phreeqc input file
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
|
||||||
|
phrRunFile executes a phreeqc run
|
||||||
|
}
|
||||||
|
\synopsis{
|
||||||
|
phrRunFile(filename)
|
||||||
|
}
|
||||||
|
\usage{
|
||||||
|
phrRunFile(filename)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{filename}{
|
||||||
|
The file name of the phreeqc input file.
|
||||||
|
}
|
||||||
|
} %END arguments
|
||||||
|
\details{
|
||||||
|
|
||||||
|
Any details about the operation of this function should go here.
|
||||||
|
|
||||||
|
} %END details
|
||||||
|
\value{
|
||||||
|
This function returns NULL.
|
||||||
|
}
|
||||||
|
\references{
|
||||||
|
Literature references and web URLs can go here.
|
||||||
|
}
|
||||||
|
\author{
|
||||||
|
Scott Charlton <charlton@usgs.gov>
|
||||||
|
|
||||||
|
Lopaka(Rob) Lee <rclee@usgs.gov>
|
||||||
|
}
|
||||||
|
\seealso{
|
||||||
|
\code{\link{phrReadString}},
|
||||||
|
\code{\link{phrRun}},
|
||||||
|
\code{\link{phrGetSelectedOutput}}
|
||||||
|
}
|
||||||
|
|
||||||
|
\examples{
|
||||||
|
|
||||||
|
# This will only work if ex1 is in the current directory
|
||||||
|
phrRunFile("phreeqc/ex1")
|
||||||
|
}
|
||||||
|
\keyword{interface}
|
||||||
Loading…
x
Reference in New Issue
Block a user