x3p_raster_relabel_NA: Relabel mask of an 'x3p' object for inclusion of missing...

View source: R/x3p_raster_relabel.R

x3p_raster_relabel_NAR Documentation

Relabel mask of an 'x3p' object for inclusion of missing values This function allows a user to relabel a mask of an 'x3p' object The user is also allowed to specify a new mask name and mask color.

Description

Relabel mask of an 'x3p' object for inclusion of missing values This function allows a user to relabel a mask of an 'x3p' object The user is also allowed to specify a new mask name and mask color.

Usage

x3p_raster_relabel_NA(
  df,
  mask_1,
  mask_2,
  color_new,
  annotation_new,
  multiple = FALSE,
  select_col
)

Arguments

df

object of class 'x3p' or a tibble style dataframe containing 'x3p' objects

mask_1

old mask label the user wishes to replace, must be a color code #8digits

mask_2

new mask label user wishes to replace with old mask label, must be a color code #8digits

color_new

Optional color specification for new mask label

annotation_new

Rename label associated with the new mask

multiple

clarify whether user is working with a single 'x3p' object or multiple in a tibble style dataframe

select_col

if multiple = TRUE, location of the x3p objects

Value

'x3p' object with altered mask


xazip/x3pLeaX documentation built on July 14, 2022, 5:37 p.m.