[Stpp-commits] r49 - pkg/man

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

Author: gabriele
Date: 2012-04-20 15:33:48 +0200 (Fri, 20 Apr 2012)
New Revision: 49

Added:
   pkg/man/sim.stpp.Rd
Modified:
   pkg/man/rinfec.Rd
   pkg/man/rinter.Rd
   pkg/man/rlgcp.Rd
   pkg/man/rpcp.Rd
   pkg/man/rpp.Rd
Log:


Modified: pkg/man/rinfec.Rd
===================================================================
--- pkg/man/rinfec.Rd	2012-04-20 12:28:22 UTC (rev 48)
+++ pkg/man/rinfec.Rd	2012-04-20 13:33:48 UTC (rev 49)
@@ -55,7 +55,7 @@
 A list containing:
 \item{xyt}{matrix (or list of matrices if \code{nsim}>1)
 containing the points (x,y,t) of the simulated point pattern.
-\code{xyt} (or any element of the list if \code{nsim}>1)) is an object 
+\code{xyt} (or any element of the list if \code{nsim}>1) is an object 
 of the class \code{stpp}.}
 \item{s.region, t.region}{parameters passed in argument.}
 }

Modified: pkg/man/rinter.Rd
===================================================================
--- pkg/man/rinter.Rd	2012-04-20 12:28:22 UTC (rev 48)
+++ pkg/man/rinter.Rd	2012-04-20 13:33:48 UTC (rev 49)
@@ -50,7 +50,7 @@
 A list containing:
 \item{xyt}{matrix (or list of matrices if \code{nsim}>1)
 containing the points (x,y,t) of the simulated point pattern.
-\code{xyt} (or any element of the list if \code{nsim}>1)) is an object 
+\code{xyt} (or any element of the list if \code{nsim}>1) is an object 
 of the class \code{stpp}.}
 \item{s.region, t.region}{parameters passed in argument.}
 }

Modified: pkg/man/rlgcp.Rd
===================================================================
--- pkg/man/rlgcp.Rd	2012-04-20 12:28:22 UTC (rev 48)
+++ pkg/man/rlgcp.Rd	2012-04-20 13:33:48 UTC (rev 49)
@@ -122,7 +122,7 @@
 A list containing:
 \item{xyt}{matrix (or list of matrices if \code{nsim}>1)
 containing the points (x,y,t) of the simulated point pattern.
-\code{xyt} (or any element of the list if \code{nsim}>1)) is an object 
+\code{xyt} (or any element of the list if \code{nsim}>1) is an object 
 of the class \code{stpp}.}
 \item{s.region, t.region}{parameters passed in argument.}
 \item{Lambda}{nx * ny * nt array (or list of array if \code{nsim}>1) 

Modified: pkg/man/rpcp.Rd
===================================================================
--- pkg/man/rpcp.Rd	2012-04-20 12:28:22 UTC (rev 48)
+++ pkg/man/rpcp.Rd	2012-04-20 13:33:48 UTC (rev 49)
@@ -57,7 +57,7 @@
 A list containing:
 \item{xyt}{matrix (or list of matrices if \code{nsim}>1)
 containing the points (x,y,t) of the simulated point pattern.
-\code{xyt} (or any element of the list if \code{nsim}>1)) is an object 
+\code{xyt} (or any element of the list if \code{nsim}>1) is an object 
 of the class \code{stpp}.}
 \item{s.region, t.region}{parameters passed in argument.}
 }

Modified: pkg/man/rpp.Rd
===================================================================
--- pkg/man/rpp.Rd	2012-04-20 12:28:22 UTC (rev 48)
+++ pkg/man/rpp.Rd	2012-04-20 13:33:48 UTC (rev 49)
@@ -44,7 +44,7 @@
 A list containing:
 \item{xyt}{matrix (or list of matrices if \code{nsim}>1)
 containing the points (x,y,t) of the simulated point pattern.
-\code{xyt} (or any element of the list if \code{nsim}>1)) is an object 
+\code{xyt} (or any element of the list if \code{nsim}>1) is an object 
 of the class \code{stpp}.}
 \item{t.index}{vector of times index.}
 \item{Lambda}{nx x ny x nt array of the intensity surface at each time.}

Added: pkg/man/sim.stpp.Rd
===================================================================
--- pkg/man/sim.stpp.Rd	                        (rev 0)
+++ pkg/man/sim.stpp.Rd	2012-04-20 13:33:48 UTC (rev 49)
@@ -0,0 +1,50 @@
+\name{sim.stpp}
+\alias{sim.stpp}
+\title{Generate spatio-temoral point patterns}
+
+\description{
+Generate one (or several) realisation(s) of a spatio-temporal point process in a region S x T.
+}
+
+\usage{
+sim.stpp(class="poisson", s.region, t.region, npoints=NULL, nsim=1, ...)
+}
+
+\arguments{
+  \item{class}{Must be chosen among "poisson", "cluster", "cox", "infectious" and "inhibition".} 
+  \item{s.region}{two-column matrix specifying polygonal region containing
+  all data locations. 
+   If \code{s.region} is missing, the unit square is considered.}
+  \item{t.region}{vector containing the minimum and maximum values of
+  the time interval. 
+   If \code{t.region} is missing, the interval [0,1] is considered.}
+  \item{npoints}{number of points to simulate.} 
+  \item{nsim}{number of simulations to generate. Default is 1.}
+  \item{...}{additional parameters related to the \code{class} parameter.
+  See \code{\link{rpp}} for the Poisson process; \code{\link{rpcp}} for the Poisson 
+  cluster process; \code{\link{rlgcp}} for the Log-Gaussian Cox process; 
+  \code{\link{rinter}} for the interaction (inhibition or contagious) 
+  process and \code{\link{rinfec}} for the infectious process.}
+}
+
+\value{
+A list containing:
+\item{xyt}{matrix (or list of matrices if \code{nsim}>1)
+containing the points (x,y,t) of the simulated point pattern.
+\code{xyt} (or any element of the list if \code{nsim}>1) is an object 
+of the class \code{stpp}.}
+\item{s.region, t.region}{parameters passed in argument.}
+}
+
+\author{
+Edith Gabriel <edith.gabriel at univ-avignon.fr>
+}
+
+\seealso{
+ \code{\link{rpp}}, \code{\link{rinfec}}, \code{\link{rinter}}, 
+ \code{\link{rpcp}} and  \code{\link{rlgcp}} for the simulation of 
+ Poisson, infectious, interaction, Poisson cluster and log-gaussian 
+ Cox processes respectively; and \code{\link{plot.stpp}}, 
+ \code{\link{animation}} and \code{\link{stan}} for plotting space-time 
+ point patterns. }
+