Skip to content

Commit cead344

Browse files
committed
Tweak main help file
1 parent 15f8239 commit cead344

File tree

3 files changed

+51
-14
lines changed

3 files changed

+51
-14
lines changed

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: spatstat.linnet
2-
Version: 1.3-0
3-
Date: 2020-12-19
2+
Version: 1.65-0
3+
Date: 2020-12-21
44
Title: Linear Networks Functionality of the 'spatstat' Package
55
Authors@R: c(person("Adrian", "Baddeley",
66
role = c("aut", "cre"),

inst/doc/packagesizes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
date version nhelpfiles nobjects ndatasets Rlines srclines
22
"2020-12-13" "1.3-0" 133 282 0 10490 3080
3-
"2020-12-19" "1.3-0" 133 282 0 10505 3080
3+
"2020-12-21" "1.65-0" 133 282 0 10505 3080

man/spatstat.linnet-package.Rd

Lines changed: 48 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,62 @@
44
\docType{package}
55
\title{The spatstat.linnet Package}
66
\description{
7-
The \pkg{spatstat.linnet} package is a subset of the
8-
\pkg{spatstat} package containing the functionality
9-
for spatial data on a linear network.
7+
The \pkg{spatstat.linnet} package
8+
belongs to the \pkg{spatstat} family of packages.
9+
It contains the functionality
10+
for analysing spatial data on a linear network.
1011
}
1112
\details{
12-
\pkg{spatstat} is a package for the statistical analysis
13-
of spatial data. Its main focus is the analysis of
13+
\pkg{spatstat} is
14+
a family of \R packages
15+
for the statistical analysis of spatial data.
16+
Its main focus is the analysis of
1417
spatial patterns of points in two-dimensional space.
1518

16-
The orginal \pkg{spatstat} package has grown to be very large.
17-
It is now in the process of being divided into several
18-
\bold{sub-packages}.
19+
The original \pkg{spatstat} package
20+
has now been split into several
21+
sub-packages.
22+
1923

2024
This sub-package \pkg{spatstat.linnet} contains the
2125
user-level functions from \pkg{spatstat}
2226
that are concerned with spatial data on a linear network.
23-
24-
(Most of the remaining functionality is
25-
in the separate sub-package \pkg{spatstat.core}.)
27+
}
28+
\section{Structure of the spatstat family}{
29+
The orginal \pkg{spatstat} package grew to be very large.
30+
It has now been divided into several \bold{sub-packages}:
31+
\itemize{
32+
\item \pkg{spatstat.utils} containing basic utilities
33+
\item \pkg{spatstat.sparse} containing linear algebra utilities
34+
\item \pkg{spatstat.data} containing datasets
35+
\item \pkg{spatstat.geom} containing geometrical objects
36+
and geometrical operations
37+
\item \pkg{spatstat.core} containing the main functionality
38+
for statistical analysis and modelling of spatial data
39+
\item \pkg{spatstat.linnet} containing functions for
40+
spatial data on a linear network
41+
\item \pkg{spatstat}, which simply loads the other sub-packages
42+
listed above, and provides documentation.
43+
}
44+
When you install \pkg{spatstat}, these sub-packages are also
45+
installed. Then if you load the \pkg{spatstat} package by typing
46+
\code{library(spatstat)}, the other sub-packages listed above will
47+
automatically be loaded or imported.
48+
For an overview of all the functions available in these sub-packages,
49+
see the help file for \pkg{spatstat} in the \pkg{spatstat} package,
50+
51+
Additionally there are several \bold{extension packages:}
52+
\itemize{
53+
\item \pkg{spatstat.gui} for interactive graphics
54+
\item \pkg{spatstat.local} for local likelihood
55+
(including geographically weighted regression)
56+
\item \pkg{spatstat.Knet} for additional, computationally efficient code
57+
for linear networks
58+
\item \pkg{spatstat.sphere} (under development) for spatial data
59+
on a sphere, including spatial data on the earth's surface
60+
}
61+
The extension packages must be installed separately
62+
and loaded explicitly if needed. They also have separate documentation.
2663
}
2764
\section{Licence}{
2865
This library and its documentation are usable under the terms of the "GNU

0 commit comments

Comments
 (0)