Description Usage Arguments Value References Examples
This function takes a latitude/longitude coordinate pair alongside a desired
distance to map and retrieves USGS (and optionally ESRI) map data, converts
said data into matrices, and runs the data through rayshader
using
sensible defaults in order to return a 2D shaded map relief. It requires a
functioning internet connection in order to retrieve data.
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 | automap(
lat = NULL,
lng = NULL,
distance = 10,
method = c("2d", "3d"),
img.width = 600,
img.height = 600,
overlay = NULL,
z = 9,
overlay.alpha = 0.75,
colorscale = "imhof4",
color.intensity = 1,
max.darken = 0.5,
sun.angle = 315,
sun.altitude = 45,
water.cutoff = 0.999,
water.min.area = length(heightmap)/400,
water.max.height = NULL,
solid = TRUE,
shadow = TRUE,
water = FALSE,
waterdepth = 0,
theta = 45,
phi = 45,
fov = 0,
zoom = 1,
save.file = c(FALSE, "tif", "png", TRUE),
from.file = c(FALSE, "tif", "png", TRUE),
tif.filename = NULL,
png.filename = NULL,
dist.unit = c("km", "miles", "m", "ft"),
coord.unit = c("degrees", "radians"),
sr_bbox = 4326,
sr_image = 4326,
print.map = TRUE
)
|
lat |
The latitude for the map's centroid, in decimal degrees or radians. |
lng |
The longitude for the map's centroid, in decimal degrees or radians. |
distance |
The distance between the centroid and any corner of the (square) output map to include. |
method |
Should a 2d or 3d plot be produced? |
img.width |
Image width, in pixels |
img.height |
Image height, in pixels |
overlay |
ESRI overlay map to include, if any – see
|
z |
zscale, passed to various rayshader functions. Defined as the ratio between the x and y spacing (which are assumed to be equal) and the z axis. For contiguous United States, USGS data is generally available at a ~9 meter spacing, with elevation provided in meter increments, resulting in a z value of 9 returning roughly representative maps; decrease this value to exaggerate elevation features. |
overlay.alpha |
Alpha value for the optional overlay layer. |
colorscale |
Color scale for land and water elements. If a vector of length 1, the same color scale will be applied for both land and water. If greater than length 1, values named "water" or "watercolor" will be used for water coloring, while "land" or "landcolor" will be used for land. |
color.intensity |
Intensity of color mapping – higher values result in more intense colors. |
max.darken |
Passed to |
sun.angle |
Angle around the matrix from which lights originate. Values line up with compass directions – so 0 is directly North, while the default 315 places the sun in the Northwest. |
sun.altitude |
Angle in degrees from horizon from which light originates. Bounded [0, 90]. |
water.cutoff |
Passed to |
water.min.area |
Passed to |
water.max.height |
Passed to |
solid |
Logical – should the output be rendered as a solid
( |
shadow |
Logical – should shadows be rendered? |
water |
Logical – should water be rendered? |
waterdepth |
Water level. |
theta |
Rotation around z axis. |
phi |
Azimuth angle. |
fov |
Field of view angle. |
zoom |
Zoom factor. |
save.file |
Should the heightmap ( |
from.file |
Should the map be built from local |
tif.filename |
If |
png.filename |
If |
dist.unit |
Units for the distance argument. All units are converted to kilometers, with some errors in the transition due to floating point arithmetic – so if high accuracy is needed, convert units to kilometers beforehand. |
coord.unit |
Units for latitude and longitude, in either decimal degrees or radians. |
sr_bbox |
Spatial reference code (ISO 19111) for bounding box |
sr_image |
Spatial reference code (ISO 19111) for image |
print.map |
Logical – should the output map be printed? |
A rayshader map object, by default printed and returned invisibly.
Archuleta, C.M., Constance, E.W., Arundel, S.T., Lowe, A.J., Mantey, K.S., and Phillips, L.A., 2017, The National Map seamless digital elevation model specifications: U.S. Geological Survey Techniques and Methods, book 11, chap. B9, 39 p., https://doi.org/10.3133/tm11B9
1 2 3 4 5 6 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.