File: epi.asc.Rd

package info (click to toggle)
r-cran-epir 2.0.80%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,332 kB
  • sloc: makefile: 5
file content (49 lines) | stat: -rw-r--r-- 1,449 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
\name{epi.asc}

\alias{epi.asc}

\title{
Write matrix to an ASCII raster file
}

\description{
Writes a data frame to an ASCII raster file, suitable for display in a Geographic Information System.
}

\usage{
epi.asc(dat, file, xllcorner, yllcorner, cellsize, na = -9999)
}

\arguments{
  \item{dat}{a matrix with data suitable for plotting using the \code{image} function.}
  \item{file}{character string specifying the name and path of the ASCII raster output file.}
  \item{xllcorner}{the easting coordinate corresponding to the lower left hand corner of the matrix.}
  \item{yllcorner}{the northing coordinate corresponding to the lower left hand corner of the matrix.}
  \item{cellsize}{number, defining the size of each matrix cell.}
  \item{na}{scalar, defines null values in the matrix. NAs are converted to this value.}
}

\value{
Writes an ASCII raster file (typically with \code{*.asc} extension), suitable for display in a Geographic Information System.
}

\note{
The \code{image} function in R rotates tabular data counter clockwise by 90 degrees for display. A matrix of the form:

\tabular{ll}{
1 \tab 3 \cr
2 \tab 4 \cr
 }
 
is displayed (using \code{image}) as:

\tabular{ll}{
3 \tab 4 \cr
1 \tab 2 \cr
 }

It is recommended that the source data for this function is a matrix. Replacement of \code{NA}s in a data frame extends processing time for this function. 
}

\keyword{univar}