[Mmsar-commits] r12 - pkg/man

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

Author: fguilhaumon
Date: 2010-02-06 20:25:04 +0100 (Sat, 06 Feb 2010)
New Revision: 12

Modified:
   pkg/man/weibull.Rd
Log:


Modified: pkg/man/weibull.Rd
===================================================================
--- pkg/man/weibull.Rd	2010-02-06 19:03:59 UTC (rev 11)
+++ pkg/man/weibull.Rd	2010-02-06 19:25:04 UTC (rev 12)
@@ -2,40 +2,34 @@
 \Rdversion{1.1}
 \alias{weibull}
 \docType{data}
-\title{
-%%   ~~ data name/kind ... ~~
+\title{The cumulative weibull distribution SAR regression model (3 parameters)}
+\description{S == c(1 - exp(-z * A^f))
 }
-\description{
-%%  ~~ A concise (1-5 lines) description of the dataset. ~~
-}
 \usage{data(weibull)}
 \format{
   The format is:
-List of 9
- $ name       : chr "Cumulative Weibull"
- $ formula    :  expression(S == c(1 - exp(-z * A^f)))
- $ paramnumber: num 3
- $ paramnames : chr [1:3] "c" "z" "f"
- $ limits     : num [1:2, 1:3] 0 Inf 0 Inf 0 ...
- $ parLim     : chr [1:3] "Rplus" "Rplus" "Rplus"
- $ fun        :function (par, data)  
-  ..- attr(*, "source")= chr "function(par,data){if(length(data)>1) d=data[[1]] else d=data; s = par[1] *  (1 - exp(-par[2]*(d^par[3])) ) ; as.vector(s)}"
- $ rssfun     :function (par, data, opt)  
-  ..- attr(*, "source")= chr "function(par,data,opt){if(opt)par=backLink(par,weibull$parLim) ; sum( ( data[[2]] -   par[1] *  (1 - exp(-par[2]*(data[[1]]^par"| __truncated__
- $ init       :function (data)  
-  ..- attr(*, "source")= chr [1:13] "function(data){" ...
+List of 8
+ $ name       : "Cumulative Weibull"
+ $ formula    : expression(S == c(1 - exp(-z * A^f)))
+ $ paramnumber: 3
+ $ paramnames : "c" "z" "f"
+ $ parLim     : "Rplus" "Rplus" "Rplus"
+ $ fun        : model function
+ $ rssfun     : Residual Sum of Squares function
+ $ init       : initial values calculation
 }
-\details{
-%%  ~~ If necessary, more details than the __description__ above ~~
+\details{The cumulative Weibull distribution (Weibull, 1951) is sigmoid asymptotic. Parameter C is the upper asymptote.It goes through the origin of axes.
 }
-\source{
-%%  ~~ reference to a publication or URL from which the data were obtained ~~
+\source{Weibull (1951), Tjørve (2003).
 }
 \references{
-%%  ~~ possibly secondary sources and usages ~~
+Tjørve, E. (2003) Shapes and functions of species–area curves: a review of possible models. Journal of Biogeography, 30, 827–835.
+
+Weibull, W. (1951) A statistical distribution function of wide applicability. Journal of Applied Mathematics, 18, 293–296.
+
 }
 \examples{
+#loading the weibull model object before using it
 data(weibull)
-## maybe str(weibull) ; plot(weibull) ...
 }
-\keyword{datasets}
+\keyword{mmSAR model object, non linear regression}