R/c4a_citation.R

In cols4all: Colors for all

#' Show how to cite palettes
#'
#' Show how to cite palettes
#'
#' @param name name of a palette or series
#' @param verbose should text be printed (if FALSE only a `utils::bibentry` object is returned)
#' @return `utils::bibentry` object
#' @example ./examples/c4a_citation.R
#' @export
c4a_citation = function(name, verbose = TRUE) {
	is_series = name %in% c4a_series(as.data.frame = FALSE)

	if (!is_series) {
		inf = c4a_info(name, no.match = NULL, verbose = FALSE)
		if (is.null(inf)) {
			if (verbose) message(paste0("\"", name, "\" is not a known series or palette name"))
			return(invisible(NULL))
		} else {
			name = inf$name
			series = inf$series
		}
	} else {
		series = name
	}

	bnames = names(.C4A$zbib)
	split_names = lapply(bnames, function(bn) {
		strsplit(bn, split = ".", fixed = TRUE)[[1]][-1]
	})
	split_series = sapply(bnames, function(bn) {
		strsplit(bn, split = ".", fixed = TRUE)[[1]][1]
	})



	if (is_series) {
		if (!(name %in% bnames)) {
			if (!(name %in% split_series)) {
				if (verbose) message("No citation information (bibentry) found for series \"", series, "\"")
			} else {
				if (verbose) message("Citation information for series \"", series, "\" is arranged per palette. So please specify the full palette name")
			}
			return(invisible(NULL))
		}
		bib = .C4A$zbib[[name]]
	} else {
		match_name = sapply(split_names, function(sn) {
			name %in% sn
		})
		match_series = (series == split_series)
		if (any(match_name & match_series)) {
			bib = .C4A$zbib[[which(match_name & match_series)]]
		} else {
			if (!(series %in% bnames)) {
				if (verbose) message("No citation information (bibentry) found for palette \"", name, "\" from series \"", series, "\"")
				return(invisible(NULL))
			}
			is_series = TRUE
			bib = .C4A$zbib[[series]]
		}
	}

	if (verbose) {
		cat("\n")

		if (is_series) {
			cat(paste0("To cite palettes from series \"", series, "\" in publications use:\n\n"))
		} else {
			cat(paste0("To cite palette ", name, " from series \"", series, "\" in publications use:\n\n"))
		}

		print(bib, style = "text")
		cat("\n")

		print(bib, style = "Bibtex")
	}
	invisible(bib)
}