[Mmsar-commits] r16 - pkg/man

noreply at r-forge.r-project.org noreply at r-forge.r-project.org
Sun Feb 7 02:46:49 CET 2010


Author: fguilhaumon
Date: 2010-02-07 02:46:49 +0100 (Sun, 07 Feb 2010)
New Revision: 16

Modified:
   pkg/man/asymp.Rd
   pkg/man/expo.Rd
   pkg/man/logist.Rd
   pkg/man/lomolino.Rd
   pkg/man/monod.Rd
   pkg/man/negexpo.Rd
   pkg/man/power.Rd
Log:


Modified: pkg/man/asymp.Rd
===================================================================
--- pkg/man/asymp.Rd	2010-02-07 01:35:41 UTC (rev 15)
+++ pkg/man/asymp.Rd	2010-02-07 01:46:49 UTC (rev 16)
@@ -17,7 +17,7 @@
  $ rssfun     : Residual Sum of Squares function
  $ init       : initial values calculation from Ratkowsky (1983) p178
 }
-\details{This model is convex asymptotic. Parameter c is the upper asymptote.
+\details{This model is convex asymptotic. Parameter c is the upper asymptote. For further details and documentation please see the online documentation at http://mmsar.r-forge.r-project.org/
 }
 \source{Tjørve (2003).}
 \references{

Modified: pkg/man/expo.Rd
===================================================================
--- pkg/man/expo.Rd	2010-02-07 01:35:41 UTC (rev 15)
+++ pkg/man/expo.Rd	2010-02-07 01:46:49 UTC (rev 16)
@@ -17,7 +17,7 @@
  $ rssfun     : Residual Sum of Squares function
  $ init       : initial values calculation
 }
-\details{This model is convex non asymptotic.
+\details{This model is convex non asymptotic. For further details and documentation please see the online documentation at http://mmsar.r-forge.r-project.org/
 }
 \source{Gleason (1922, 1925), Fisher et al. (1943), Tjørve (2003).
 }

Modified: pkg/man/logist.Rd
===================================================================
--- pkg/man/logist.Rd	2010-02-07 01:35:41 UTC (rev 15)
+++ pkg/man/logist.Rd	2010-02-07 01:46:49 UTC (rev 16)
@@ -17,7 +17,7 @@
  $ rssfun     : Residual Sum of Squares function
  $ init       : initial values calculation
 }
-\details{This model is sigmoid asymptotic. Parameter c is the upper asymptote. The function is symmetrical about the inflection point. The curve has a lower asymptote of zero, and the intersection with the y-axis depends on all three parameters. Thus it never goes through the origin.
+\details{This model is sigmoid asymptotic. Parameter c is the upper asymptote. The function is symmetrical about the inflection point. The curve has a lower asymptote of zero, and the intersection with the y-axis depends on all three parameters. Thus it never goes through the origin.  For further details and documentation please see the online documentation at http://mmsar.r-forge.r-project.org/
 }
 \source{Ratkowsky (1990), Tjørve (2003).
 }

Modified: pkg/man/lomolino.Rd
===================================================================
--- pkg/man/lomolino.Rd	2010-02-07 01:35:41 UTC (rev 15)
+++ pkg/man/lomolino.Rd	2010-02-07 01:46:49 UTC (rev 16)
@@ -17,7 +17,7 @@
  $ rssfun     : Residual Sum of Squares function
  $ init       : initial values calculation
 }
-\details{The lomolino model is sigmoid asymptotic. Parameter c is the upper asymptote.
+\details{The lomolino model is sigmoid asymptotic. Parameter c is the upper asymptote. For further details and documentation please see the online documentation at http://mmsar.r-forge.r-project.org/
 }
 \source{Lomolino, M.V. (2000), Tjørve (2003).
 }

Modified: pkg/man/monod.Rd
===================================================================
--- pkg/man/monod.Rd	2010-02-07 01:35:41 UTC (rev 15)
+++ pkg/man/monod.Rd	2010-02-07 01:46:49 UTC (rev 16)
@@ -17,7 +17,7 @@
  $ rssfun     : Residual Sum of Squares function
  $ init       : initial values calculation
 }
-\details{The Monod function SAR model is convex asymptotic.
+\details{The Monod function SAR model is convex asymptotic. For further details and documentation please see the online documentation at http://mmsar.r-forge.r-project.org/
 }
 \source{Monod (1950), Tjørve (2003).
 }

Modified: pkg/man/negexpo.Rd
===================================================================
--- pkg/man/negexpo.Rd	2010-02-07 01:35:41 UTC (rev 15)
+++ pkg/man/negexpo.Rd	2010-02-07 01:46:49 UTC (rev 16)
@@ -17,7 +17,7 @@
  $ rssfun     : Residual Sum of Squares function
  $ init       : initial values calculation
 }
-\details{The negative exponential model is convex asymptotic.
+\details{The negative exponential model is convex asymptotic. For further details and documentation please see the online documentation at http://mmsar.r-forge.r-project.org/
 }
 \source{Holdridge et al. (1971), Miller & Wiegert (1989), Ratkowsky (1990), Tjørve (2003).
 }

Modified: pkg/man/power.Rd
===================================================================
--- pkg/man/power.Rd	2010-02-07 01:35:41 UTC (rev 15)
+++ pkg/man/power.Rd	2010-02-07 01:46:49 UTC (rev 16)
@@ -2,42 +2,32 @@
 \Rdversion{0.1}
 \alias{power}
 \docType{data}
-\title{
-%%   ~~ The power law SAR model (Arrhenius 1921) ~~
-}
-\description{
-%%  ~~ The power law SAR model is the most ancient model fitted to SARs.\cr
-
-	\tab s == c * a^z ~~
-}
+\title{The power law SAR model}
+\description{s == c * a^z}
 \usage{The power model is an argument of the rssoptim function, it can be passed along with other models to the multiSAR function}
 \format{
   The format is:
 List of 9
- $ name       : chr "Power"
- $ formula    :  expression(s == c * a^z)
- $ paramnumber: num 2
- $ paramnames : chr [1:2] "c" "z"
- $ limits     : num [1:2, 1:2] 0 Inf 0 1
- $ parLim     : chr [1:2] "Rplus" "unif"
- $ rssfun     :function (par, data, opt)  
-  ..- attr(*, "source")= chr "function(par,data,opt){if(opt)par=backLink(par,power$parLim) ; sum(   (data[,2] - par[1]*data[,1]^par[2]) ^2     )}"
- $ fun        :function (par, data)  
-  ..- attr(*, "source")= chr "function(par,data){if(length(data)>1) d=data[[1]] else d=data; s = par[1]*d^par[2]; names(s)=c(\"s.power\"); s}"
- $ init       :function (data)  
-  ..- attr(*, "source")= chr "function(data){log.data=log(data);res=lm(s~a,log.data)$coefficients;c(exp(res[1]),res[2])}"
+ $ name       : "Power"
+ $ formula    : expression(s == c * a^z)
+ $ paramnumber: 2
+ $ parLim     : "Rplus" "unif"
+ $ fun        : model function
+ $ rssfun     : Residual Sum of Squares function
+ $ init       : initial values calculation
 }
-\details{
-%%  ~~ If necessary, more details than the __description__ above ~~
+\details{The power SAR mdoel is convex non asymptotic. For further details and documentation please see the online documentation at http://mmsar.r-forge.r-project.org/
 }
-\source{
-%%  ~~ Arrhenius, O. 1921. Species and area. Journal of Ecology. 9: 95-99.  ~~
+\source{Arrhenius (1921), Tjørve (2003).
 }
 \references{
-%%  ~~ Arrhenius, O. 1921. Species and area. Journal of Ecology. 9: 95-99. ~~
+Arrhenius, O. 1921. Species and area. Journal of Ecology. 9: 95-99.
+
+Tjørve, E. (2003) Shapes and functions of species–area curves: a review of possible models. Journal of Biogeography, 30, 827–835.
 }
 \examples{
-rssoptim(power,data)
+#loading the power model object before using it
+data(power)
 }
 \keyword{mmSAR model object}
 \keyword{non linear regression}



More information about the Mmsar-commits mailing list