R/c4a_scores.R

In cols4all: Colors for all

#' Get information from a cols4all palette
#'
#' Get information from a cols4all palette
#'
#' @param palette name of the palette
#' @param type type of palettes (in case palette is not specified)
#' @param series series name (in case palette is not specified)
#' @param n number of colors
#' @param no.match what happens is no match is found? Options: `"message"`: a message is thrown with suggestions, `"error"`: an error is thrown, `"null"`: `NULL` is returned
#' @param verbose should messages be printed?
#' @return list with the following items: name, series, fullname, type, palette (colors), na (color), nmax, and reverse. The latter is `TRUE` when there is a `"-"` prefix before the palette name.
#' @export
#' @example examples/c4a_scores.R
c4a_scores = function(palette = NULL, type = NULL, series = NULL, n = NA, no.match = c("message", "error", "null"), verbose = TRUE) {
	if (!is.null(palette)) {
		z = get_zp(palette, n, no.match = no.match, verbose = verbose)
	} else {
		if (is.null(type)) stop("Please specify either palette or type (optionally in combination with series)")
		if (is.na(n)) n = .C4A$ndef[[type]]
		pals = c4a_palettes(type = type, series = series)
		z = do.call(rbind, lapply(pals, get_zp, no.match = no.match, verbose = verbose))

	}
	show_attach_scores(z)
}