RPhreeCheckSel: Generate and/or check the selection of output from Rphree

In Rphree: Interface to the geochemical modelling program PHREEQC

Description

Utility function to check if the selected output vector, specifying the blocks included in the output of Rphree, is well formed. The selection vector has the form: c(kin=FALSE, tot=TRUE, desc=TRUE, species = TRUE, pphases = TRUE, SI=TRUE, punch =FALSE), where the names of each vector component refer to corresponding blocks in PHREEQC output.

Usage

RPhreeCheckSel(sel)

Arguments

sel	A named logical vector of length 7. If missing, the function returns a valid selection vector with all components set to FALSE.

Details

This utility function is quite needed since the precise order of this vector is in c-level hard-coded!

Value

A well formed selection vector

Author(s)

MDL

Examples

## Not run: 
## A valid example
mysel <- c(kin=FALSE, tot=TRUE, desc=TRUE, species = TRUE, pphases = TRUE, SI=TRUE, punch =FALSE)

## Let RPhreeCheckSel generate a selection:
sel <- RPhreeCheckSel()
sel <- !RPhreeCheckSel()

## End(Not run)

Rphree documentation built on May 2, 2019, 6:09 p.m.