|
4 | 4 | \docType{package}
|
5 | 5 | \title{The spatstat.linnet Package}
|
6 | 6 | \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. |
10 | 11 | }
|
11 | 12 | \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 |
14 | 17 | spatial patterns of points in two-dimensional space.
|
15 | 18 |
|
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 | + |
19 | 23 |
|
20 | 24 | This sub-package \pkg{spatstat.linnet} contains the
|
21 | 25 | user-level functions from \pkg{spatstat}
|
22 | 26 | 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. |
26 | 63 | }
|
27 | 64 | \section{Licence}{
|
28 | 65 | This library and its documentation are usable under the terms of the "GNU
|
|
0 commit comments