Skip to contents

All functions

Arith(<GRaster>,<logical>) Arith(<logical>,<GRaster>) Arith(<GRaster>,<numeric>) Arith(<GRaster>,<integer>) Arith(<numeric>,<GRaster>) Arith(<integer>,<GRaster>) Arith(<GRaster>,<GRaster>) Arith(<GVector>,<GVector>)
Arithmetic operations on GRasters
Compare(<GRaster>,<GRaster>) Compare(<logical>,<GRaster>) Compare(<GRaster>,<logical>) Compare(<numeric>,<GRaster>) Compare(<GRaster>,<numeric>) Compare(<GRaster>,<integer>) Compare(<integer>,<GRaster>) Compare(<GRaster>,<character>) Compare(<character>,<GRaster>) Compare(<GRegion>,<GRegion>)
Compare-methods operations on GRasters and GRegions
GLocation-class GLocation GSpatial-class GSpatial GRegion-class GRegion GRaster-class GRaster GVector-class GVector
Classes for fasterRaster sessions, regions, rasters, and vectors
Logic(<GRaster>,<GRaster>) Logic(<logical>,<GRaster>) Logic(<GRaster>,<logical>) Logic(<GRaster>,<numeric>) Logic(<numeric>,<GRaster>) Logic(<GRaster>,<integer>) Logic(<integer>,<GRaster>)
Logic-methods operations on GRasters
activeCat(<GRaster>) activeCats(<GRaster>) `activeCat<-`(<GRaster>)
Get or set the column with category labels in a categorical raster
`add<-`(<GRaster>,<GRaster>)
"Stack" a GRaster
addCats(<GRaster>) `addCats<-`(<GRaster>)
Add rows or columns to the "levels" table of a categorical raster
`addTable<-`(<GVector>,<data.frame>) `addTable<-`(<GVector>,<data.table>) `addTable<-`(<GVector>,<matrix>) dropTable(<GVector>)
Attach or detach GVector's data table
aggregate(<GRaster>) aggregate(<GVector>)
Aggregate raster cells into larger cells or combine geometries of a vector
app(<GRaster>) appFuns() appCheck(<GRaster>,<character>)
Apply a function to a set of rasters
appFunsTable
Functions that can be used in app()
as.contour(<GRaster>)
Contour lines from a "GRaster"
as.data.frame(<GVector>) as.data.table(<GVector>)
Convert GVector to a data frame
as.int(<GRaster>) as.float(<GRaster>) as.doub(<GRaster>)
Coerce raster to integer, float, or double precision
as.lines(<GRaster>)
Convert a raster to a lines vector
as.points(<GRaster>) as.points(<GVector>)
Convert a GRaster, or lines or polygons GVector to a points vector
as.polygons(<GRaster>)
Convert a raster to a polygons vector
bioclims(<GRaster>) bioclims(<SpatRaster>)
BIOCLIM rasters
breakPolys(<GVector>) fixBridges(<GVector>) fixDangles(<GVector>) fixLines(<GVector>) remove0(<GVector>) removeAngles(<GVector>) removeBridges(<GVector>) removeDangles(<GVector>) removeDupCentroids(<GVector>) removeDups(<GVector>) removeSmallPolys(<GVector>) snap(<GVector>)
Fix issues with geometries of a vector
buffer(<GRaster>) buffer(<GVector>) st_buffer(<GVector>)
Increase/decrease the size of a vector or around non-NA cells of a raster
c(<GRaster>)
"Stack" GRasters
catNames(<GRaster>) catNames(<SpatRaster>)
Names of columns of the levels table of a categorical raster
cellSize(<GRaster>)
Area of GRaster cells
classify(<GRaster>)
Classify GRaster cell values
clump(<GRaster>)
Group adjacent cells with similar values
clusterPoints(<GVector>)
Identify clusters of points
colbind(<GVector>)
Add columns to the data table of a GVector
combineCats(<GRaster>)
Combine values/categories of multiple GRasters into a single GRaster
combineLevels(<GRaster>) combineLevels(<list>)
Combine levels table from multiple categorical GRasters
compareGeom(<GRaster>,<GRaster>) compareGeom(<GVector>,<GVector>) compareGeom(<GRaster>,<GVector>) compareGeom(<GVector>,<GRaster>)
Determine if GRasters and/or GVectors are geographically comparable
complete.cases(<GRaster>) complete.cases(<GVector>) missing.cases(<GRaster>) missing.cases(<GVector>)
Rows of a GRaster or GVector's table that have no NAs or that have NAs
compositeRGB(<GRaster>)
Combine red, green, and blue color bands to make a composite GRaster
connectors(<GVector>,<GVector>)
Create lines connecting nearest features of two GVectors
convHull(<GVector>)
Minimum convex hull around a spatial vector
crds(<GRaster>) crds(<GVector>) st_coordinates()
Coordinates of a vector"s features or a raster"s cell centers
crop(<GRaster>) crop(<GVector>)
Remove parts of a GRaster or GVector
crs(<missing>) crs(<GLocation>) st_crs()
Coordinate reference system of a GRaster or GVector
datatype(<GRaster>) datatype(<GVector>)
Get the datatype of a GRaster or of GVector columns
delaunay(<GVector>)
Delaunay triangulation for points
denoise(<GRaster>) noise(<GRaster>)
Remove or retain "noise" in a raster using PCA
dim(<GRegion>) dim3d(<missing>) dim3d(<GRegion>) nrow(<missing>) nrow(<GRegion>) ncol(<missing>) ncol(<GRegion>) ndepth(<missing>) ndepth(<GRegion>) ncell(<missing>) ncell(<GRegion>) ncell3d(<missing>) ncell3d(<GRegion>) dim(<GVector>) nrow(<GVector>) ncol(<GVector>) nlyr(<missing>) nlyr(<GRaster>)
Number of rows, columns, depths, cells, and layers
disagg(<GVector>)
Coerce as multipart GVector to a singlepart GVector
distance(<GRaster>,<missing>) distance(<GRaster>,<GVector>) distance(<GVector>,<GVector>) distance(<GVector>,<missing>)
Geographic distance
dropRows(<data.table>) dropRows(<data.frame>) dropRows(<matrix>)
Remove rows in a data.table, data.frame, or matrix.
droplevels(<GRaster>)
Remove rows from the "levels" table of a categorical raster
erase(<GVector>,<GVector>)
Select parts of a polygon GVector erase shared by another polygon GVector
expanse(<GVector>)
Area of polygons or length of lines
ext(<missing>) ext(<GSpatial>) zext(<missing>) zext(<GSpatial>) W(<missing>) W(<GSpatial>) E(<missing>) E(<GSpatial>) N(<missing>) N(<GSpatial>) S(<missing>) S(<GSpatial>) top(<missing>) top(<GSpatial>) bottom(<GSpatial>)
Spatial bounds of a GRaster or GVector
extend(<GRaster>,<numeric>) extend(<GRaster>,<SpatRaster>) extend(<GRaster>,<SpatVector>) extend(<GRaster>,<SpatExtent>) extend(<GRaster>,<sf>) extend(<GRaster>,<GSpatial>)
Add rows and columns around a writeRaster
extract(<GRaster>,<GVector>) extract(<GRaster>,<data.frame>) extract(<GRaster>,<data.table>) extract(<GRaster>,<matrix>) extract(<GRaster>,<numeric>) extract(<GVector>,<GVector>) extract(<GVector>,<data.frame>) extract(<GVector>,<data.table>) extract(<GVector>,<matrix>) extract(<GVector>,<numeric>)
Extract values from a GRaster at locations in a points GVector
fast(<character>) fast(<SpatRaster>) fast(<SpatVector>) fast(<sf>) fast(<missing>) fast(<numeric>) fast(<data.frame>) fast(<data.table>) fast(<matrix>)
Create a GRaster or GVector
fastData()
Get one of the example rasters or spatial vectors
faster()
Set or get options shared across "fasterRaster" functions
fillHoles(<GVector>)
Fill holes in a GVector
fillNAs(<GRaster>)
Fill NA cells in a raster using interpolation
flow(<GRaster>)
Identify watershed basins and direction and accumulation of flow
flowPath(<GRaster>)
Path of water flow across a landscape
focal(<GRaster>)
Calculate cell values based on values of nearby cells
fractalRast(<GRaster>)
Create fractal raster
fragmentation(<SpatRaster>) fragmentation(<GRaster>)
Landscape fragmentation class following Riitters et al. (2020)
freq(<GRaster>)
Frequencies of cell values in a raster
mean(<GRaster>) mmode(<GRaster>) median(<GRaster>) count(<GRaster>) sum(<GRaster>) min(<GRaster>) max(<GRaster>) which.min(<GRaster>) which.max(<GRaster>) sdpop(<numeric>) varpop(<GRaster>) varpop(<numeric>) stdev(<GRaster>) var(<GRaster>) nunique(<GRaster>) skewness(<GRaster>) kurtosis(<GRaster>) slope(<GRaster>) intercept(<GRaster>) r2(<GRaster>) tvalue(<GRaster>) range(<GRaster>) quantile(<GRaster>)
Mathematical operations on two or more GRasters
geomorphons(<GRaster>)
Identify terrain feature types
geomtype(<GVector>) is.points(<GVector>) is.lines(<GVector>) is.polygons(<GVector>)
Geometry of a GVector (points, lines, or polygons)
global(<GRaster>) global(<missing>)
Summary statistics for GRasters
grassInfo()
GRASS citation, version, and copyright information
grassStarted()
Has "GRASS" been started or not?
grid(<GRaster>) grid(<GVector>)
Create a grid GVector
head(<GVector>) tail(<GVector>)
Return first or last part of the data frame of a GVector
hexagons(<GRaster>) hexagons(<GVector>)
Create a hexagonal grid
hillshade(<GRaster>)
Hillshading
hist(<GRaster>)
Plot a histogram of raster values
horizonHeight(<GRaster>)
Horizon height
interpIDW(<GVector>,<GRaster>)
Interpolate values at points to a GRaster using inverse-distance weighting
interpSplines(<GVector>,<GRaster>)
Interpolate values at points to a GRaster using splines
intersect(<GVector>,<GVector>)
Intersection of two GVectors
is.2d(<GSpatial>) is.3d(<GSpatial>)
Test if a GRaster or GVector is 2- or 3-dimensional
is.int(<GRaster>) is.cell(<GRaster>) is.float(<GRaster>) is.doub(<GRaster>) is.factor(<GRaster>)
Data type of a raster
is.lonlat(<character>) is.lonlat(<GLocation>) is.lonlat(<sf>)
Test if a coordinate reference system is unprojected
kernel(<GVector>)
Kernel density estimator of points
layerCor(<GRaster>)
Correlation between GRasters
levels(<GRaster>) cats(<GRaster>) categories(<GRaster>) `levels<-`(<GRaster>,<data.frame>) `levels<-`(<GRaster>,<data.table>) `levels<-`(<GRaster>,<GRaster>) `levels<-`(<GRaster>,<list>)
Set and get categories for categorical rasters
longlat(<GRaster>)
Create longitude/latitude rasters
madChelsa
Rasters of bioclimatic variables for an eastern portion of Madagascar
madCoast
Shapefile of a portion of the coastline of Madagascar
madCoast4
Spatial vector of a portion of the coastline of Madagascar
madCoast4
Spatial vector of a portion of the coastline of Madagascar
madCover
Raster of land cover for an eastern portion of Madagascar
madCoverCats
Table of land cover classes for an eastern portion of Madagascar
madDypsis
Spatial points vector of records of Dypsis in eastern Madagascar
madElev
Elevation raster for an eastern portion of Madagascar
madForest2000
Forest cover in year 2000 for a portion of Madagascar
madForest2014
Forest cover in year 2014 for a portion of Madagascar
madLANDSAT
Rasters of surface reflectance for an eastern portion of Madagascar
madPpt
Rasters of average monthly precipitation for an eastern portion of Madagascar
madRivers
Major rivers in a selected portion of Madagascar
madTmax
Rasters of average monthly maximum temperature for an eastern portion of Madagascar
madTmin
Rasters of average monthly minimum temperature for an eastern portion of Madagascar
mask(<GRaster>,<GRaster>) mask(<GRaster>,<GVector>)
Mask values in a raster
maskNA(<GRaster>)
Mask all non-NA cells or all NA cells
match(<GRaster>) `%in%`(<GRaster>) `%notin%`(<GRaster>)
Find which cells of a GRaster match certain values
is.na(<GRaster>) not.na(<GRaster>) abs(<GRaster>) sin(<GRaster>) cos(<GRaster>) tan(<GRaster>) asin(<GRaster>) acos(<GRaster>) atan(<GRaster>) atan2(<GRaster>,<GRaster>) exp(<GRaster>) log1p(<GRaster>) log10p(<GRaster>) log(<GRaster>) ln(<GRaster>) log2(<GRaster>) log10(<GRaster>) sqrt(<GRaster>) round(<GRaster>) floor(<GRaster>) ceiling(<GRaster>) trunc(<GRaster>)
Mathematical operations on each layer of a GRasters
merge(<GRaster>,<GRaster>)
Combine two or more rasters with different extents and fill in NAs
minmax(<GRaster>)
Minimum and maximum values or categories of a GRaster
missingCats(<GRaster>)
Values in a categorical raster with no assigned category
mow()
Remove unused rasters and vectors from the GRASS cache
nacell(<GRaster>) nonnacell(<GRaster>)
Number of NA or non-NA cells in a raster
names(<GRaster>) `names<-`(<GRaster>) names(<GVector>) `names<-`(<GVector>)
Name(s) of a GRaster or columns of a GVector's data table
ngeom(<GVector>) nsubgeom(<GVector>)
Number of geometries and subgeometries in a vector
nlevels(<GRaster>)
Number of categories in a categorical raster
pairs(<GRaster>)
Scatterplot of values in each GRaster layer against the others
pca(<GRaster>)
Apply a principal component analysis (PCA) to layers of a GRaster
pcs()
Retrieve a principal components model from a PCA GRaster
plot(<GRaster>,<missing>) plot(<GVector>,<missing>)
Display a raster or vector
plotRGB(<GRaster>)
Create red-green-blue plot from a raster with RGB layers
predict(<GRaster>)
Make predictions from a linear or generalized linear model to a GRaster
project(<GRaster>) project(<GVector>)
Change the coordinate reference system of a GRaster or GVector
rSpatialDepRast(<GRaster>)
Create a random raster with or without spatial dependence
rast(<GRaster>)
Convert a GRaster to a SpatRaster
rasterize(<GVector>,<GRaster>)
Convert a GVector to a GRaster
rbind(<GVector>)
Combine one or more GVectors
reorient(<GRaster>) reorient(<numeric>)
Convert degrees between 'north-orientation' and 'east orientation'
replaceNAs(<data.frame>) replaceNAs(<matrix>) replaceNAs(<data.table>) replaceNAs(<numeric>) replaceNAs(<integer>) replaceNAs(<logical>) replaceNAs(<character>)
Replace NAs in a data.table or data.frame column, or in a vector
`$<-`(<GRaster>) `$<-`(<GVector>)
Replace a raster layer or a column from a vector's data table
`[[<-`(<GRaster>,<ANY>)
Replace layers of a GRaster
`[<-`(<GRaster>,<missing>,<ANY>) `[<-`(<GRaster>,<GRaster>,<ANY>)
Replace values of a GRaster
res(<missing>) res(<GRegion>) xres(<missing>) xres(<GRegion>) yres(<missing>) yres(<GRegion>) zres(<missing>) zres(<GRegion>) res3d(<missing>) res3d(<GRegion>)
Spatial resolution
resample(<GRaster>,<GRaster>) resample(<GRaster>,<numeric>)
Change the cell size of a GRaster
rnormRast(<GRaster>)
Create a raster with random values drawn from a normal distribution
ruggedness(<GRaster>)
Terrain ruggedness index
runifRast(<GRaster>)
Create a raster with random values drawn from a uniform distribution
rvoronoi(<GRaster>) rvoronoi(<GVector>)
Create a randomly-positioned tesselation
sampleRast(<GRaster>)
Randomly sample cells from a GRaster
scale(<GRaster>) scalepop(<GRaster>) unscale(<GRaster>)
Center and scale a GRaster, or the opposite
selectRange(<GRaster>)
Select values from rasters in a stack based on values in another raster
seqToSQL()
Format a numeric series into an SQL value call
simplifyGeom(<GVector>)
Simplify the geometry of a vector
sineRast(<GRaster>)
Sine wave rasters
smoothGeom(<GVector>)
Smooth the geometry of a vector
sources(<GRaster>) sources(<GVector>) sources(<character>)
Name of a raster or vector in a GRASS session
spatSample(<GRaster>) spatSample(<GVector>)
Sample random points from a GRaster or GVector
streams(<GRaster>)
Create stream network
stretch(<GRaster>)
Rescale values in a raster
`$`(<GRaster>) `$`(<GVector>)
Subset a GRaster layer, or return values from a column of a GVector's table
`[[`(<GRaster>,<ANY>,<ANY>) `[[`(<GVector>,<ANY>,<ANY>)
Subset layers from a GRaster, or specific columns from a GVector
`[`(<GVector>,<ANY>,<ANY>) `[`(<GRaster>,<GRaster>,<ANY>)
Subset geometries of a GVector
subst(<GRaster>)
Replace a specific value(s) in a GRaster
sun()
Solar radiance and irradiance
terrain(<GRaster>)
Slope, aspect, curvature, and partial slopes
thinLines(<GRaster>)
Reduce linear features on a raster so linear features are 1 cell wide
thinPoints(<GVector>,<GRaster>)
Reduce number of points in same raster cell
tiles(<GRaster>)
Divide a GRaster into spatially exclusive subsets
topology(<GSpatial>)
Topology (2- or 3-dimensions) of a GRaster or GVector
trim(<GRaster>)
Remove rows and columns from a raster that are all NA
tutorial_getting_started
Getting started with "fasterRaster"
tutorial_hidden_functions
Hidden functions in "fasterRester"
tutorial_locations_mapsets
Locations/projects and mapsets
tutorial_raster_data_types
Raster data types
tutorial_regions
An explanation of GRASS "regions"
union(<GVector>,<GVector>)
Combine two GVectors
update(<GRaster>) update(<GVector>)
Refresh metadata in a GRaster or GVector
vect(<GVector>) st_as_sf(<GVector>)
Convert a GVector to a SpatVector or sf vector
vegIndex(<GRaster>)
Vegetation indices from surface reflectance
vegIndices
Table of vegetation indices that can be calculated from remote sensing surface reflectance data using vegIndex(). A near-comprehensive table of indices can be found on the Index Database: A Database for Remote Sensing Indices.
voronoi(<GVector>)
Voronoi tessellation
wetness(<GRaster>)
Topographic wetness index
workDir(<GLocation>)
Get a GLocation's working directory
writeRaster(<GRaster>,<character>) writeRaster(<missing>,<missing>)
Save a GRaster to disk
writeVector(<GVector>,<character>) writeVector(<missing>,<missing>)
Save a GVector to disk
xor(<GVector>,<GVector>)
Select parts of polygons not shared between two GVectors
zonal(<GRaster>,<ANY>)
Statistics on cells of a GRaster stratified by cells of another raster
zonalGeog(<GRaster>)
Geographic statistics for sets of cells with the same values