Skip to contents

Function to create a static plot from raster data with discrete data

elsar_plot_static_raster_d.Rd

[Deprecated]

elsar_plot_static_raster_d() is deprecated. Please use elsar_plot_static_raster() with data_type = "discrete" instead.

Usage

elsar_plot_static_raster_d(
  raster_in,
  type = "ggplot_vector",
  categorical = FALSE,
  number_categories = 10,
  data_layer = NULL,
  background = NULL,
  extend_background = 0.05,
  custom_palette = NULL,
  plot_title = "",
  legend_title = NULL,
  color_map = "viridis",
  expand_plot = FALSE,
  raster_df_out = FALSE
)

Arguments

raster_in

The SpatRaster file to be plotted.

type

A character of the plot type. Either "ggplot_vector", "ggplot_raster" or "tmap".

categorical

Logical. Only used when data_type = "discrete". If TRUE, data is already categorical.

number_categories

Integer. Only used when data_type = "discrete". Number of categories to split continuous data into. Default is 10.

data_layer

Character. Only used when data_type = "discrete". The data layer name for categorization.

background

Requires a SpatRaster input (preferably with the same data as raster_in) to plot the background data.

extend_background

A numerical value that allows to extent the background beyond the extent of raster_in. If extend_background <= 1, the lat and lon extend will be extended by the ratio provided (e.g. 0.05 will extend it by 5%). If extend_background > 1 all sides will be extended by the absolute value provided.

custom_palette

An optional custom palette for plotting. Default uses the viridis package.

plot_title

An optional plot title.

legend_title

An optional legend title.

color_map

The name of the viridis palette to be used. Default is "viridis".

expand_plot

Logical. Whether to expand the plot, so there is no space between border and plot.

raster_df_out

Logical. Whether to return only the plot (FALSE) or also the data frame behind the plot (TRUE). Needed for elsar_plot_distribution().

Value

Either a ggplot object or a list with the ggplot and the df.

See also

elsar_plot_static_raster() for the unified plotting function

Examples

if (FALSE) { # \dontrun{
boundary_proj <- make_boundary(
  boundary_in = boundary_dat,
  iso3 = "NPL",
  iso3_column = "iso3cd"
)

pus <- make_planning_units(
  boundary_proj = boundary_proj,
  iso3 = "NPL",
  pu_size = NULL,
  pu_threshold = 8.5e5,
  limit_to_mainland = FALSE
)
wad_dat <- get_wad_data()

wadOut <- make_normalised_raster(
  raster_in = wad_dat,
  pus = pus,
  iso3 = "NPL"
)

(plot_cat <- elsar_plot_static_raster_d(raster_in = wadOut,
type = "ggplot_raster",
categorical = FALSE,
number_categories = 10,
background = wad_dat,
data_layer = "wad_final_cog",
raster_df_out = TRUE)
)
} # }