From 9bbc3aa6296578d736aeda1ecf0de41671f1f795 Mon Sep 17 00:00:00 2001 From: Scott R Charlton Date: Wed, 5 Feb 2014 07:17:50 +0000 Subject: [PATCH] updating docs git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8433 1feff8c3-07ed-0310-ac33-dd36852eb9cd --- R/phreeqc/man/phrLoadDatabase.Rd | 37 +++++++++++--------------------- 1 file changed, 13 insertions(+), 24 deletions(-) diff --git a/R/phreeqc/man/phrLoadDatabase.Rd b/R/phreeqc/man/phrLoadDatabase.Rd index 9043be97..ebc79176 100644 --- a/R/phreeqc/man/phrLoadDatabase.Rd +++ b/R/phreeqc/man/phrLoadDatabase.Rd @@ -1,28 +1,15 @@ \name{phrLoadDatabase} \alias{phrLoadDatabase} -\title{ - Read phreeqc database file -} +\title{Load a phreeqc database file} \description{ - - phrLoadDatabase loads a phreeqc database file into ... -} -\synopsis{ - phrLoadDatabase(filename) + Loads a phreeqc database into the IPhreeqcCOM object. Returns NULL if successful. } \usage{ - phrLoadDatabase(filename) + phrLoadDatabase(filename) } \arguments{ -\item{filename}{ - The file name of the database. -} + \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. } @@ -30,18 +17,20 @@ Literature references and web URLs can go here. } \author{ - Scott Charlton - + Scott Charlton \email{charlton@usgs.gov} } \seealso{ - \code{\link{phrReadString}}, - \code{\link{phrRun}}, - \code{\link{phrGetSelectedOutput}} + \code{\link{phrLoadDatabaseString}} } \examples{ - # This will only work if phreeqc.dat is in the current directory - phrLoadDatabase("phreeqc/phreeqc.dat") +# This will only work if phreeqc/phreeqc.dat is in the current directory +if (is.null(phrLoadDatabase("phreeqc/phreeqc.dat"))) { + cat("database ok\n") +} else { + cat("database contains errors\n") +} + } \keyword{interface}