[Seacarb-commits] r5 - pkg/seacarb3/man

[noreply at r-forge.r-project.org]

Author: karlines
Date: 2009-01-06 09:53:54 +0100 (Tue, 06 Jan 2009)
New Revision: 5

Added:
   pkg/seacarb3/man/seacarb3.Rd
Modified:
   pkg/seacarb3/man/speciation.Rd
Log:
Added main help file. Now help can be triggered with ?seacarb 
Corrected small error/inconsistency in speciation example ("version" -> "k1k2") 



Added: pkg/seacarb3/man/seacarb3.Rd
===================================================================
--- pkg/seacarb3/man/seacarb3.Rd	                        (rev 0)
+++ pkg/seacarb3/man/seacarb3.Rd	2009-01-06 08:53:54 UTC (rev 5)
@@ -0,0 +1,46 @@
+\name{seacarb-package}
+\alias{seacarb-package}
+\alias{seacarb3}
+\alias{seacarb}
+\docType{package}
+\title{
+Calculates parameters of the seawater carbonate system (additions and changes proposed to the original seacarb)
+}
+\description{
+Calculates parameters of the seawater carbonate system
+}
+\details{
+  \tabular{ll}{
+    Package: \tab seacarb3\cr
+    Type: \tab Package\cr
+    Version: \tab 3.0\cr
+    Date: \tab 2009-??-??\cr
+    License: \tab GNU Public License 2 or above\cr
+  }
+
+}
+\author{
+
+  Heloise Lavigne, Aurelien Proye, Philippe Grosjean and Jean-Pierre Gattuso (maintainer).
+
+  Portions of code and/or corrections were contributed by Jean-Marie Epitalon, Bernard Gentili, Jim Orr and Karline Soetaert
+  
+}
+\references{
+
+}
+
+\examples{
+\dontrun{
+## show examples (see respective help pages for details)
+example(bjerrum)
+example(K1)
+
+## open the directory with documents
+browseURL(paste(system.file(package="seacarb3"), "/data", sep=""))
+
+
+}
+}
+
+\keyword{ package }

Modified: pkg/seacarb3/man/speciation.Rd
===================================================================
--- pkg/seacarb3/man/speciation.Rd	2008-12-24 16:06:05 UTC (rev 4)
+++ pkg/seacarb3/man/speciation.Rd	2009-01-06 08:53:54 UTC (rev 5)
@@ -68,8 +68,8 @@
 plot(SpC)
 # superpose curves using Roy et al., 1993 algorithm
 SpCR <- speciation(swconc(2.04, "CT", unit = "mmol/kg-soln", stp = stp()),
-	pH = swpH(seq(0, 14, 0.1), "T"), K1 = K1(stp(), version = "r"),
-	K2 = K2(stp(), version = "r"))
+	pH = swpH(seq(0, 14, 0.1), "T"), K1 = K1(stp(), k1k2 = "r"),
+	K2 = K2(stp(), k1k2 = "r"))
 plot(SpCR, col = "red", add = TRUE)
 legend("left", inset = 0.05, col = c("red", "black"), lty = 1, bg = "white",
 	legend = c("Roy et al., 1993", "Lueker et al., 2000"))