[Raster-commits] r210 - pkg/raster/man

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

Author: jacobvanetten
Date: 2009-01-29 13:00:58 +0100 (Thu, 29 Jan 2009)
New Revision: 210

Modified:
   pkg/raster/man/rasterdistance.Rd
Log:
distance documentation

Modified: pkg/raster/man/rasterdistance.Rd
===================================================================
--- pkg/raster/man/rasterdistance.Rd	2009-01-29 08:48:45 UTC (rev 209)
+++ pkg/raster/man/rasterdistance.Rd	2009-01-29 12:00:58 UTC (rev 210)
@@ -3,9 +3,15 @@
 \alias{distance-methods}
 \alias{distance}
 \alias{distance,RasterLayer-method}
-\title{ Calculate distance}
+\title{ Calculate distance from geographic features in a raster}
 \description{
- ~~ Methods for function \code{distance}  ~~
+ The function calculates the distance from the non-NA cells of the RasterLayer.
+ 
+ The distance is in meters if the RasterLayer is in a geographic (latlon) projection and in map units when not projected.
+ 
+ Distances are calculated by summing local distances between cells, which are connected with their neighbours in 8 directions.
+ 
+ For more options (directions, cost-distance) see the gdistance package.
 }
 \section{Methods}{
 \describe{