Improve help files

spatstat · Oct 7, 2022 · 62fdae7 · 62fdae7
1 parent 4cc88a7
commit 62fdae7
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 11 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: spatstat.geom
-Version: 2.999-999.005
-Date: 2022-09-20
+Version: 2.999-999.006
+Date: 2022-10-07
 Title: Geometrical Functionality of the 'spatstat' Family 
 Authors@R: c(person("Adrian", "Baddeley", 
                     role = c("aut", "cre"),

diff --git a/NEWS b/NEWS
@@ -1,4 +1,4 @@
-        CHANGES IN spatstat.geom VERSION 2.999-999.005
+        CHANGES IN spatstat.geom VERSION 2.999-999.006
 
 OVERVIEW
 

diff --git a/inst/doc/packagesizes.txt b/inst/doc/packagesizes.txt
@@ -11,4 +11,4 @@ date version nhelpfiles nobjects ndatasets Rlines srclines
 "2021-12-10" "2.3-1" 440 1176 0 34643 15173
 "2022-02-12" "2.3-2" 440 1176 0 34657 15173
 "2022-03-28" "2.4-0" 441 1178 0 34804 15188
-"2022-09-20" "2.999-999.005" 442 1182 0 35107 15325
+"2022-10-07" "2.999-999.006" 442 1182 0 35107 15325
diff --git a/man/delaunay.Rd b/man/delaunay.Rd
@@ -12,11 +12,14 @@ delaunay(X)
 }
 \details{
   The Delaunay triangulation of a spatial point pattern \code{X}
-  is defined as follows. First the Dirichlet/Voronoi tessellation of \code{X}
-  computed; see \code{\link{dirichlet}}. Then two points of \code{X}
+  is defined as follows. First the Dirichlet/Voronoi tessellation
+  based on \code{X} is computed; see \code{\link{dirichlet}}. This
+  tessellation is extended to cover the entire two-dimensional plane.
+  Then two points of \code{X}
   are defined to be Delaunay neighbours if their Dirichlet/Voronoi tiles
   share a common boundary. Every pair of Delaunay neighbours is
-  joined by a straight line. The result is a tessellation, consisting of
+  joined by a straight line to make the Delaunay triangulation.
+  The result is a tessellation, consisting of
   disjoint triangles. The union of these triangles is the convex hull of
   \code{X}.
 }

diff --git a/man/delaunayDistance.Rd b/man/delaunayDistance.Rd
@@ -13,23 +13,36 @@ delaunayDistance(X)
 }
 \details{
   The Delaunay triangulation of a spatial point pattern \code{X}
-  is defined as follows. First the Dirichlet/Voronoi tessellation of \code{X}
-  computed; see \code{\link{dirichlet}}. Then two points of \code{X}
+  is defined as follows. First the Dirichlet/Voronoi tessellation
+  based on \code{X} is computed; see \code{\link{dirichlet}}. This
+  tessellation is extended to cover the entire two-dimensional plane.
+  Then two points of \code{X}
   are defined to be Delaunay neighbours if their Dirichlet/Voronoi tiles
   share a common boundary. Every pair of Delaunay neighbours is
-  joined by a straight line.
+  joined by a straight line to make the Delaunay triangulation.
 
   The \emph{graph distance} 
   in the Delaunay triangulation between two points \code{X[i]} and \code{X[j]}
   is the minimum number of edges of the Delaunay triangulation
   that must be traversed to go from \code{X[i]} to \code{X[j]}.
+  Two points have graph distance 1 if they are immediate neighbours.
 
   This command returns a matrix \code{D} such that
   \code{D[i,j]} is the graph distance
   between \code{X[i]} and \code{X[j]}.
 }
+\section{Definition of neighbours}{
+  Note that \code{\link{dirichlet}(X)}
+  restricts the Dirichlet tessellation to the window containing
+  \code{X}, whereas \code{dirichletDistance} uses the Dirichlet
+  tessellation over the entire two-dimensional plane.
+  Some points may be Delaunay neighbours
+  according to \code{delaunayDistance(X)}
+  although the corresponding tiles of \code{dirichlet(X)}
+  do not share a boundary inside \code{Window(X)}.
+}
 \value{
-  A symmetric square matrix with integer entries.
+  A symmetric square matrix with non-negative integer entries.
 }
 \seealso{
   \code{\link{delaunay}},