save_png: Save PNG

View source: R/save_png.R

save_pngR Documentation

Save PNG

Description

Writes the hillshaded map to file.

Usage

save_png(
  hillshade,
  filename,
  title_text = NA,
  title_offset = c(20, 20),
  title_color = "black",
  title_size = 30,
  title_font = "sans",
  title_style = "normal",
  title_bar_color = NULL,
  title_bar_alpha = 0.5,
  title_position = "northwest",
  rotate = 0,
  asp = 1
)

Arguments

hillshade

Array (or matrix) of hillshade to be written.

filename

String with the filename. If '.png' is not at the end of the string, it will be appended automatically.

title_text

Default 'NULL'. Text. Adds a title to the image, using 'magick::image_annotate()'.

title_offset

Default 'c(20,20)'. Distance from the top-left (default, 'gravity' direction in image_annotate) corner to offset the title.

title_color

Default 'black'. Font color.

title_size

Default '30'. Font size in pixels.

title_font

Default 'sans'. String with font family such as "sans", "mono", "serif", "Times", "Helvetica", "Trebuchet", "Georgia", "Palatino" or "Comic Sans".

title_style

Default 'normal'. Font style (e.g. 'italic').

title_bar_color

Default 'NULL'. If a color, this will create a colored bar under the title.

title_bar_alpha

Default '0.5'. Transparency of the title bar.

title_position

Default 'northwest'. Position of the title.

rotate

Default 0. Rotates the output. Possible values: 0, 90, 180, 270.

asp

Default '1'. Aspect ratio of the resulting plot. Use 'asp = 1/cospi(mean_latitude/180)' to rescale lat/long at higher latitudes to the correct the aspect ratio.

Examples

filename_map = tempfile()

#Save the map into `filename_map`
montereybay %>%
 sphere_shade() %>%
 save_png(filename_map)
 
#Rotate the map 180 degrees:

montereybay %>%
 sphere_shade() %>%
 save_png(filename_map,rotate=180)

tylermorganwall/rayshader documentation built on Dec. 21, 2024, 4:29 p.m.