Skip to content

Commit

Permalink
Merge pull request #1497 from kadyb/master
Browse files Browse the repository at this point in the history
fix typos in docs
  • Loading branch information
rhijmans authored May 13, 2024
2 parents 423a4fc + 613e244 commit 6803edd
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Authors@R: c(
person("Robert J.", "Hijmans", role = c("cre", "aut"),
email = "[email protected]", comment = c(ORCID = "0000-0001-5872-2872")),
person("Roger", "Bivand", role = "ctb", comment = c(ORCID = "0000-0003-2392-6140")),
person("Krzysztof", "Dyba", role = "ctb"),
person("Krzysztof", "Dyba", role = "ctb", comment = c(ORCID = "0000-0002-8614-3816")),
person("Edzer", "Pebesma", role = "ctb", comment = c(ORCID = "0000-0001-8049-7069")),
person("Michael D.", "Sumner", role = "ctb"))

12 changes: 6 additions & 6 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ Released 2023-01-31
## enhancements

- `vect<character>` now has argument "opts" for GDAL open options, e.g. to declare a file encoding. [#1389](https://github.com/rspatial/terra/issues/1389) by Mats Blomqvist
- `plot(plg=list(tic=""))` now allows chosing alternative continuous legend tic-mark styles ("in", "out", "through" or "none")
- `plot(plg=list(tic=""))` now allows choosing alternative continuous legend tic-mark styles ("in", "out", "through" or "none")
- `makeTiles` has new argument "buffer" [#1408](https://github.com/rspatial/terra/issues/1408) by Joy Flowers.


## new

- `prcomp<SpatRaster>` method [#1361](https://github.com/rspatial/terra/issues/1361#issuecomment-1860311029) by Jakub Nowosad
- `add_box` to add a box around the map. The box is drawn where the axes are, not around the plotting region.
- `getTileExtents` provides the extents of for tiles. These may be used in parallelization. See [#1391](https://github.com/rspatial/terra/issues/1391) by Alex Ilich.
- `getTileExtents` provides the extents of tiles. These may be used in parallelization. See [#1391](https://github.com/rspatial/terra/issues/1391) by Alex Ilich.


# version 1.7-65
Expand Down Expand Up @@ -120,7 +120,7 @@ Hernangómez
- SpatVector attributes can now be stored as an ordered factor [#1277](https://github.com/rspatial/terra/issues/1277) by Ben Notkin
- `plot<SpatVector>` now uses an "interval" legend when breaks are supplied [#1303](https://github.com/rspatial/terra/issues/1303) by Gonzalo Rizzo
- `crop<SpatRaster>` now keeps more metadata, including variable names [#1302](https://github.com/rspatial/terra/issues/1302) by rhgof
- `extract(fun="table")` now returns an easier to use data.frame [#1294] (https://github.com/rspatial/terra/issues/1294) by Fernando Aramburu.
- `extract(fun="table")` now returns an easier to use data.frame [#1294](https://github.com/rspatial/terra/issues/1294) by Fernando Aramburu.


## new
Expand Down Expand Up @@ -406,7 +406,7 @@ Released 2022-11-18
## enhancements

- faster `mosaic` and `merge<SpatRaster>` [#577] by Jean-Romain
- `wrap<SpatRaster>` now uses file references if the data is deemed to large to all load into memory. [#801] by Jean-Romain
- `wrap<SpatRaster>` now uses file references if the data is deemed too large to all load into memory. [#801] by Jean-Romain
- `readRDS` and `unserialize` now return a SpatRaster or SpatVector (instead of a PackedSpat*)
- better support for a "local" arbitrary Euclidean crs [#797] by Agustin Lobo
- `clamp` can now take low and high values for each layer
Expand Down Expand Up @@ -613,7 +613,7 @@ Released 2022-01-30
- writing raster files with a color table could lead to a crash [#501] by Kodi Arfer
- `crds` replicated the coordinates [#504] by Murray Efford
- `as.data.frame<SpatRaster>` returned integers if the file stored values as integers, even if there was a scale/offset that creates decimal numbers [#509] by Kodi Arfer
- `project` opened the input raster file in read/write mode intead of read mode. That did not work with files that cannot be updated.
- `project` opened the input raster file in read/write mode instead of read mode. That did not work with files that cannot be updated.

## enhancements

Expand Down Expand Up @@ -664,7 +664,7 @@ Released 2022-01-13
- `classify` with `right=FALSE` ignored `include.lowest=TRUE` [#442] by Alex Ilich
- `patches` now combines patches that connect across the data line [#366] by Hirscht
- `patches(directions=8)` now connects in NE/SW direction [#451] by Jean-François Bourdon.
- `centroids` now considers cases where SpatVector parts are nearest to each other when crossing the date line in stead of the zero-meridian [#366] by Hirscht
- `centroids` now considers cases where SpatVector parts are nearest to each other when crossing the date line instead of the zero-meridian [#366] by Hirscht
- `terrain` created empty (`NA`) rows between chunks used for processing large rasters. [#453] by Robert Ritson.
- `inset` did not draw the "box" correctly. [#457] by Márcia Barbosa
- `as.lines` now works with a points SpatVector [#464] by Márcia Barbosa
Expand Down
2 changes: 1 addition & 1 deletion man/barplot.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

\title{Bar plot of a SpatRaster}

\description{Create a barplot of the values of a the first layer of a SpatRaster. For large datasets a regular sample with a size of approximately \code{maxcells} is used.}
\description{Create a barplot of the values of the first layer of a SpatRaster. For large datasets a regular sample with a size of approximately \code{maxcells} is used.}

\usage{
\S4method{barplot}{SpatRaster}(height, maxcell=1000000, digits=0, breaks=NULL, col, ...)
Expand Down
10 changes: 5 additions & 5 deletions man/click.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
\description{
Click on a map (plot) to get the coordinates or the values of a SpatRaster or SpatVector at that location. For a SpatRaster you can also get the coordinates and cell number of the location.

This does to work well on the default RStudio plotting device. To work around that, you can first run \code{dev.new(noRStudioGD = TRUE)} which will create a separate window for plotting, then use \code{plot()} followed by \code{click()} and click on the map .
This does to work well on the default RStudio plotting device. To work around that, you can first run \code{dev.new(noRStudioGD = TRUE)} which will create a separate window for plotting, then use \code{plot()} followed by \code{click()} and click on the map.
}


Expand All @@ -29,9 +29,9 @@ This does to work well on the default RStudio plotting device. To work around th
\item{id}{logical. If \code{TRUE}, a numeric ID is shown on the map that corresponds to the row number of the output}
\item{xy}{logical. If \code{TRUE}, xy coordinates are included in the output}
\item{cell}{logical. If \code{TRUE}, cell numbers are included in the output}
\item{type}{one of "n", "p", "l" or "o". If "p" or "o" the points are plotted; if "l" or "o" they are joined by lines. See ?locator}
\item{type}{one of "n", "p", "l" or "o". If "p" or "o" the points are plotted; if "l" or "o" they are joined by lines. See \code{\link[graphics]{locator}}}
\item{show}{logical. Print the values after each click?}
\item{...}{additional graphics parameters used if type != "n" for plotting the locations. See ?locator}
\item{...}{additional graphics parameters used if type != "n" for plotting the locations. See \code{\link[graphics]{locator}}}
}

\value{
Expand All @@ -40,9 +40,9 @@ A \code{data.frame} with the value(s) of all layers of SpatRaster \code{x} for t
}

\note{
The plot only provides the coordinates for a spatial query, the values are read from the SpatRaster or SpatVector that is passed as an argument. Thus you can extract values from an object that has not been plotted, as long as it spatially overlaps with with the extent of the plot.
The plot only provides the coordinates for a spatial query, the values are read from the SpatRaster or SpatVector that is passed as an argument. Thus, you can extract values from an object that has not been plotted, as long as it spatially overlaps with the extent of the plot.

Unless the process is terminated prematurely values at at most \code{n} positions are determined. The identification process can be terminated, depending on how you interact with R, by hitting Esc, or by clicking the right mouse button and selecting "Stop" from the menu, or from the "Stop" menu on the graphics window.
Unless the process is terminated prematurely values at most \code{n} positions are determined. The identification process can be terminated, depending on how you interact with R, by hitting Esc, or by clicking the right mouse button and selecting "Stop" from the menu, or from the "Stop" menu on the graphics window.
}


Expand Down
2 changes: 1 addition & 1 deletion man/contour.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
\title{Contour plot}

\description{
Contour lines of a SpatRaster. Use \code{add=TRUE} to add the lines to the current plot. See \code{graphics::\link[graphics]{contour}} for details.
Contour lines (isolines) of a SpatRaster. Use \code{add=TRUE} to add the lines to the current plot. See \code{graphics::\link[graphics]{contour}} for details.

if \code{filled=TRUE}, a new filled contour plot is made. See \code{graphics::\link[graphics]{filled.contour}} for details.

Expand Down
4 changes: 2 additions & 2 deletions man/draw.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
\description{
Draw on a plot (map) to get a SpatVector or SpatExtent object for later use. After calling the function, start clicking on the map. When you are done, press \code{ESC}. You can also preset the maximum number of clicks.

This does to work well on the default RStudio plotting device. To work around that, you can first run \code{dev.new(noRStudioGD = TRUE)} which will create a separate window for plotting, then use \code{plot()} followed by \code{click()} and click on the map .
This does to work well on the default RStudio plotting device. To work around that, you can first run \code{dev.new(noRStudioGD = TRUE)} which will create a separate window for plotting, then use \code{plot()} followed by \code{click()} and click on the map.
}

\usage{
Expand All @@ -22,7 +22,7 @@ This does to work well on the default RStudio plotting device. To work around th
\item{col}{the color to be used}
\item{lwd}{the width of the lines to be drawn}
\item{id}{logical. If \code{TRUE}, a numeric ID is shown on the map}
\item{n}{the maximum number of clicks (does not apply when \code{x=="extent"} in which case \code{n} is always 2}
\item{n}{the maximum number of clicks (does not apply when \code{x=="extent"} in which case \code{n} is always 2)}
\item{xpd}{logical. If \code{TRUE}, you can draw outside the current plotting area}
\item{...}{additional graphics arguments for drawing}
}
Expand Down
6 changes: 3 additions & 3 deletions man/vect.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,16 @@ SpatVectors can also be created from "Well Known Text", and from spatial vector
\arguments{
\item{x}{character. A filename; or a "Well Known Text" string; SpatExtent, data.frame (to make a SpatVector of points); a "geom" matrix to make a SpatVector of any supported geometry (see examples and \code{\link{geom}}); a spatial vector data object defined in the \code{sf} or \code{sp} packages; or a list with matrices with coordinates}
\item{layer}{character. layer name to select a layer from a file (database) with multiple layers}
\item{query}{character. An query to subset the dataset in the \href{https://gdal.org/user/ogr_sql_dialect.html}{OGR-SQL dialect}}
\item{query}{character. A query to subset the dataset in the \href{https://gdal.org/user/ogr_sql_dialect.html}{OGR-SQL dialect}}
\item{extent}{Spat* object. The extent of the object is used as a spatial filter to select the geometries to read. Ignored if \code{filter} is not \code{NULL}}
\item{filter}{SpatVector. Used as a spatial filter to select geometries to read (the convex hull is used for lines or points). It is guaranteed that all features that overlap with the extent of filter will be returned. It can happen that additional geometries are returned}
\item{type}{character. Geometry type. Must be "points", "lines", or "polygons"}
\item{atts}{data.frame with the attributes. The number of rows must match the number of geometrical elements}
\item{crs}{character. The coordinate reference system in one of the following formats: WKT/WKT2, <authority>:<code>, or PROJ-string notation (see \code{\link{crs}}). See \code{\link{crs}}}
\item{crs}{character. The coordinate reference system in one of the following formats: WKT/WKT2, <authority>:<code>, or PROJ-string notation (see \code{\link{crs}})}
\item{proxy}{logical. If \code{TRUE} a SpatVectorProxy is returned}
\item{what}{character indicating what to read. Either \code{""} for geometries and attributes, or \code{"geoms"} to only read the geometries, \code{"attributes"} to only read the attributes (that are returned as a data.frame)}
\item{opts}{character. GDAL dataset open options}
\item{geom}{character. The field name(s) with the geometry data. Either two names for x and y coordinates of points, or a single name for a single column with WKT geometries)}
\item{geom}{character. The field name(s) with the geometry data. Either two names for x and y coordinates of points, or a single name for a single column with WKT geometries}
\item{keepgeom}{logical. If \code{TRUE} the geom variable(s) is (are) also included in the attributes}
}

Expand Down

0 comments on commit 6803edd

Please sign in to comment.