hyGet_palette: [+] Get color palette used to create variable'.color'

In GegznaV/spHelper: Extension of Package `hyperSpec` and Various Convenience Functions

[+] Get color palette used to create variable'.color'

Description

[+] Get color palette used to create variable'.color'

Usage

hyGet_palette(sp)

hyGet_palette0(sp)

Arguments

sp	A hyperSpec object, that contais variable .color added with function hyAdd_color

Value

Color palette used to create variable .color.

Note

If class of sp is not hyperSpec, function returns NULL.

Author(s)

Vilmantas Gegzna

See Also

Other spHelper functions for spectroscopy and hyperSpec: IQR_outliers(), binning(), file, gapDer(), hy2mat(), hyAdd_Label_wl(), hyAdd_Labels_PAP_PD_2014(), hyAdd_Labels_TD2009(), hyAdd(), hyDrop_NA(), hyRm_palette(), mad_outliers(), mean_Nsd(), median_Nmad(), plot_hyPalette(), prepare_PAP_RK_2014__MATLAB_failui(), read.OOIBase32(), read.OceanView.header(), read.OceanView(), read.sp.csv2(), read3csv2hy(), replace_spc(), sd_outliers(), spStat(), sp_class_perform()

Examples

data(Spectra2)
Spectra1 <- hyAdd_color(Spectra2, "class")

colnames(Spectra2)
   #> [1] "gr"    "class" "spc"

colnames(Spectra1)
   #> [1] "gr"     "class"  "spc"    ".color"

# Default label
labels(Spectra1,".color")
   #>  [1] "Colors for \"class\""

# Names of attributes of variable ".color":
attributes(Spectra1$.color)  %>% names
  #> [1] "palette"      "variableName"

# Values of attributes:
attributes(Spectra1$.color)
  #> $palette
  #> color label
  #> 1 #E41A1C     K
  #> 2 #377EB8     l
  #> 3 #4DAF4A     N
  #> 4 #984EA3    S1
  #>
  #> $variableName
  #> [1] "class"

# Extract color palette:
hyGet_palette(Spectra1)
   #>  "#377EB8" "#4DAF4A" "#984EA3" "#FF7F00"

   #>      colors   labels
   #>  1 #E41A1C     K
   #>  2 #377EB8     l
   #>  3 #4DAF4A     N
   #>  4 #984EA3    S1

# Extract palette (just colors) as vector:
hyGet_palette0(Spectra1)
   #>  [1] #E41A1C #377EB8 #4DAF4A #984EA3
   #>  Levels: #377EB8 #4DAF4A #984EA3 #E41A1C

# ATTENTION -------------------------------------------------

# Preserve labels/ color palette (operator ` ]<-`):
Spectra1[1,".color"] <- "red"
hyGet_palette(Spectra1)
    #>  "#377EB8" "#4DAF4A" "#984EA3" "#FF7F00"

# Overwrite labels/ color palette (operator `$<-`):
# Spectra2a$.color[1] <- "red"
# hyGet_palette(Spectra2a)
    #>  Warning message:
    #>  In hyGet_palette(Spectra2a) : Values of pallete do not exist.
    #>  Most probably they are overwriten by operation `$.color<-`.

labels(Spectra1,".color")
    #>  ".color"

GegznaV/spHelper documentation built on April 16, 2023, 1:42 p.m.