Skip to content

Commit

Permalink
readRAST.Rd: add note on GDAL-GRASS driver missing CRS metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
florisvdh committed Jun 16, 2024
1 parent de5da4d commit e1f026d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion man/readRAST.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ write_RAST(x, vname, zcol = 1, NODATA=NULL, flags=NULL,
\item{vname}{A vector of GRASS raster file names in mapsets in the current search path, as set by \dQuote{g.mapsets}; the file names may be given as fully-qualified map names using \dQuote{name@mapset}, in which case only the mapset given in the full path will be searched for the existence of the raster; if more than one raster with the same name is found in mapsets in the current search path, an error will occur, in which case the user should give the fully-qualified map name. If the fully-qualified name is used, \code{@} will be replaced by underscore in the output object.}
\item{cat}{default NULL; if not NULL, must be a logical vector matching vname, stating which (CELL) rasters to return as factor}
\item{return_format}{default \code{"terra"}, optionally \code{"SGDF"}}
\item{use_gdal_grass_driver}{Default \code{TRUE}. The \href{https://github.com/OSGeo/gdal-grass}{standalone GDAL-GRASS driver} for the raster format will be used if \code{return_format} is \code{"terra"} and if the driver is installed. The advantage is that no intermediate file(s) need to be written from GRASS GIS and subsequently read into R; instead the raster dataset(s) are read directly from the GRASS GIS database.}
\item{use_gdal_grass_driver}{Default \code{TRUE}. The \href{https://github.com/OSGeo/gdal-grass}{standalone GDAL-GRASS driver} for the raster format will be used if \code{return_format} is \code{"terra"} and if the driver is installed. The advantage is that no intermediate file(s) need to be written from GRASS GIS and subsequently read into R; instead the raster dataset(s) are read directly from the GRASS GIS database. Please read the \strong{Note} further below!}
\item{ignore.stderr}{default taking the value set by \code{set.ignore.stderrOption}; can be set to TRUE to silence \code{system()} output to standard error; does not apply on Windows platforms}
\item{close_OK}{default TRUE - clean up possible open connections used for reading metadata; may be set to FALSE to avoid the side-effect of other user-opened connections being broken}
\item{x}{A \pkg{terra} \code{"SpatRaster"} or \pkg{sp} \code{"SpatialGridDataFrame"} object}
Expand All @@ -34,6 +34,10 @@ write_RAST(x, vname, zcol = 1, NODATA=NULL, flags=NULL,

\value{\code{read_RAST} by default returns a SpatRaster object, but may return a legacy SpatialGridDataFrame object if \code{return_format="SGDF"}. \code{write_RAST} silently returns the object being written to GRASS.}

\note{
Be aware that the GDAL-GRASS driver may currently return incomplete metadata about the coordinate reference system, e.g. it may miss the EPSG code.
}

\author{Roger S. Bivand, e-mail: \email{Roger.Bivand@nhh.no}}

\examples{
Expand Down

0 comments on commit e1f026d

Please sign in to comment.