max/iphreeqc
1
0
Fork 0
mirror of https://git.gfz-potsdam.de/naaice/iphreeqc.git synced 2025-12-16 16:44:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

updated phrSetLogFileOn

Browse Source 
git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8647 1feff8c3-07ed-0310-ac33-dd36852eb9cd
This commit is contained in:
Scott R Charlton 2014-04-10 07:04:11 +00:00
parent 9c0b2202db
commit 73486ab2a1
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
R/phreeqc/R/phreeqc.R
View File

@ -1132,34 +1132,34 @@ function(filename)
} }
##' Set log file on/off.
##' TODO
##' ##'
##' %% ~~ A concise (1-5 lines) description of what the function does. ~~ ##' Sets the log file switch on or off. This switch controls whether
##' or not phreeqc writes log messages to the log file. The initial
##' setting is off.
##'
##' Logging must be enabled through the use of the KNOBS -logfile
##' option in order to receive an log messages.
##' ##'
##' %% ~~ If necessary, more details than the description above ~~ ##' @export phrSetLogFileOn
##'
##' @usage phrSetLogFileOn(value)
##' @param value %% ~~Describe \code{value} here~~
##' @return %% ~Describe the value returned %% If it is a LIST, use %%
##' \item{comp1 }{Description of 'comp1'} %% \item{comp2 }{Description of
##' 'comp2'} %% ...
##' @note %% ~~further notes~~
##' @seealso %% ~~objects to See Also as \code{\link{help}}, ~~~
##' @references \url{http://wwwbrr.cr.usgs.gov/projects/GWC_coupled/phreeqc}
##' @keywords interface
##' @useDynLib phreeqc ##' @useDynLib phreeqc
##' @export ##' @param value if TRUE, writes output to the the log file.
##' @return NULL
##' @seealso \code{\link{phrGetLogFileName}}, \code{\link{phrGetLogFileOn}}, \code{\link{phrGetLogStringsOn}}, \code{\link{phrGetLogStrings}}, \c
##' @references \url{http://wwwbrr.cr.usgs.gov/projects/GWC_coupled/phreeqc}
##' @examples ##' @examples
##' ##'
##' ##---- Should be DIRECTLY executable !! ---- ##' # This example runs ex2 with the log file turned on.
##' ##-- ==> Define data, use random, ##' phrLoadDatabaseString(phreeqc.dat)
##' ##-- or do help(data=index) for the standard data sets. ##' phrSetLogStringsOn(TRUE)
##'
##' # turn logging on
##' phrAccumulateLine("KNOBS; -logfile true")
##' phrRunAccumulated()
##' ##'
##' ## The function is currently defined as ##' if (is.null(phrRunString(ex2))) {
##' function (value) ##' cat("see", phrGetLogFileName(), "\n")
##' { ##' }
##' }
##' ##'
phrSetLogFileOn = phrSetLogFileOn =
function(value) function(value)
@ -1183,7 +1183,7 @@ function(value)
##' @references \url{http://wwwbrr.cr.usgs.gov/projects/GWC_coupled/phreeqc} ##' @references \url{http://wwwbrr.cr.usgs.gov/projects/GWC_coupled/phreeqc}
##' @examples ##' @examples
##' ##'
##' # This example runs ex2 with the log file turned on. ##' # This example runs ex2 with log strings turned on.
##' phrLoadDatabaseString(phreeqc.dat) ##' phrLoadDatabaseString(phreeqc.dat)
##' phrSetLogStringsOn(TRUE) ##' phrSetLogStringsOn(TRUE)
##' ##'
@ -1243,8 +1243,8 @@ function(filename)
##' Set output file on/off. ##' Set output file on/off.
##' ##'
##' Sets the output file switch on or off. This switch controls whether ##' Sets the output file switch on or off. This switch controls whether
##' or not phreeqc writes to the phreeqc.0.out file. This is the output ##' or not phreeqc writes to the output file. This is the output normally
##' normally generated when phreeqc is run. Ths initial setting is off. ##' generated when phreeqc is run. The initial setting is off.
##' ##'
##' @export phrSetOutputFileOn ##' @export phrSetOutputFileOn
##' @useDynLib phreeqc ##' @useDynLib phreeqc