R/recup_palette.R

In oceanis: Cartography for Statistical Analysis

#' @title Returns a palette of the graphic chart of INSEE
#'
#' @description Returns a palette of the graphic chart of INSEE.
#'
#' @details Les couleurs de palettes préfixées par "Insee_" sont celles de la charte graphique
#' INSEE. En exécutant la fonction affiche_palette(nomPalette), il est possible de visualiser
#' les couleurs de chaque palette disponible.
#' Les modalités pour l'argument 'nomPalette' sont "Insee_Rouge", "Insee_Jaune", Insee_Bleu",
#' "Insee_Turquoise", "Insee_Vert", "Insee_Violet" et "Insee_Gris" pour les palettes de la
#' charte graphique INSEE, "defaut", "Turquoise_Neg", "Vert_Neg", "Violet_Neg" et "Gris_Neg"
#' pour les palettes hors charte.
#' 
#' La palette "defaut" reprend les couleurs de la palette RdYlBu de ColorBrewer.
#'
#' Seules les palettes "Insee_Rouge" et "Insee_Jaune" proposent des palettes pour des valeurs
#' négatives et positives. Pour ces deux palettes, la palette "Insee_Bleu" est utilisée
#' pour représenter les valeurs négatives. Cette dernière peut également être utilisée seule 
#' pour des valeurs uniquement positives ou négatives.
#' 
#' La fonction renvoie une liste d'un vecteur composé du nom de la palette au format
#' nomPalette_xN_yP et des valeurs hexadécimales de la palette.
#'
#' La liste des valeurs hexadécimales de toutes les palettes est disponible en
#' chargeant les données suivantes : data("palettes_insee").
#' 
#' Il est obligatoire de spécifier un nombre de classes négatives ou positives supérieur à 0 et
#' jusqu'à 6 maximum.
#' Un message d'erreur apparaîtra si les choix du nombre de couleurs négatives et positives
#' ne sont pas adaptés à la palette spécifiée.
#'
#' @usage recup_palette(stylePalette, nbNeg = 0, nbPos = 0)
#'
#' @param stylePalette chaine de caracteres (character). A choisir parmi
#' "defaut", "Insee_Rouge", "Insee_Jaune", "Insee_Bleu", "Insee_Turquoise",
#' "Insee_Vert", "Insee_Violet", "Insee_Gris", "Turquoise_Neg", "Vert_Neg",
#' "Violet_Neg" ou "Gris_Neg".
#' @param nbNeg numeric. Nombre de classes negatives. De 0 (par défaut) à 6.
#' @param nbPos numeric. Nombre de classes positives. De 0 (par défaut) à 6.
#'
#' @return Retourne une liste d'un vecteur caracteres.
#'
#' @seealso \code{\link{set_couleur_classes}}
#'
#' @references Un convertisseur de couleurs pour visualiser une couleur a
#' partir de son nom, son code hexadecimal ou RGB :
#' http://www.proftnj.com/RGB3.htm
#'
#' ColorBrewer 2.0 :
#' https://colorbrewer2.org/#type=diverging&scheme=RdYlBu&n=10
#'
#' @keywords documentation
#'
#' @examples
#'
#' recup_palette(stylePalette = "defaut", nbNeg = 3, nbPos = 3)
#'
#' # $defaut_3N3P
#' # [1] "#003269" "#005289" "#95BAE2" "#E4A75A" "#D47130" "#B24B1D"
#'
#' @export recup_palette
#'
recup_palette <-
function(stylePalette = "defaut", nbNeg = 0, nbPos = 0)
{
  msg_error1<-msg_error2<-msg_error3<-msg_error4<-msg_error5<-msg_error6 <- NULL
  
  if(!is.null(stylePalette)) if(any(class(stylePalette)!="character")) msg_error1 <- "Le style de palette est a choisir parmi 'defaut', 'Insee_Rouge', 'Insee_Jaune', 'Insee_Bleu', 'Insee_Turquoise', 'Insee_Vert', 'Insee_Violet', 'Insee_Gris', 'Turquoise_Neg', 'Vert_Neg', 'Violet_Neg' ou 'Gris_Neg' / "
  if(nbNeg < 0) msg_error2 <- "Le nombre de classes negative doit etre superieur ou egal a zero / "
  if(nbPos < 0) msg_error3 <- "Le nombre de classes positive doit etre superieur ou egal a zero / "
  if(nbNeg == 0 & nbPos == 0) msg_error4 <- "Le nombre de classes positive ou negative doit etre superieur a zero / "
  if(nbNeg > 6 | nbPos > 6) msg_error5 <- "Le nombre de classes positive ou negative doit etre inferieur ou egal a 6 / "
  if(!is.null(stylePalette)) if(!stylePalette %in% c("defaut", "Insee_Rouge", "Insee_Jaune", "Insee_Bleu", "Insee_Turquoise", "Insee_Vert", "Insee_Violet", "Insee_Gris", "Turquoise_Neg", "Vert_Neg", "Violet_Neg", "Gris_Neg")) msg_error6 <- "Le style de palette est a choisir parmi 'defaut', 'Insee_Jaune', 'Insee_Rouge', 'Insee_Bleu', 'Insee_Turquoise', 'Insee_Vert', 'Insee_Violet', 'Insee_Gris', 'Turquoise_Neg', 'Vert_Neg', 'Violet_Neg' ou 'Gris_Neg' / "
  
  if(any(!is.null(msg_error1),!is.null(msg_error2),!is.null(msg_error3),!is.null(msg_error4),!is.null(msg_error5),!is.null(msg_error6)))
  {
    stop(simpleError(paste0(msg_error1,msg_error2,msg_error3,msg_error4,msg_error5,msg_error6)))
  }
  
  col_palette <- palettes_insee[which(names(palettes_insee) == paste0(stylePalette,"_",nbNeg,"N",nbPos,"P"))]
  
  if(length(col_palette) == 0)
  {
    stop(simpleError("La palette choisie n'est pas adaptee aux classes des donnees."))
  }
  
  return(col_palette)
}