Skip to content

Commit

Permalink
add pkg anchor to documentation links to external functions (using \l…
Browse files Browse the repository at this point in the history
…ink[pkg]{fn} notation) to prevent CRAN check NOTE (see manual for Writing R Extensions)
  • Loading branch information
hneth committed Jul 15, 2024
1 parent 7997f95 commit 3df1273
Show file tree
Hide file tree
Showing 29 changed files with 36 additions and 36 deletions.
4 changes: 2 additions & 2 deletions R/FU_Berlin.R
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ fu_blues <- unikn::newpal(col = c(fu_blue, "#164574", "#2C5682", "#426890", "#58
#' of the \href{https://www.fu-berlin.de/en/index.html}{Free University Berlin}, Germany.
#'
#' See \code{\link{fu_0_2023}} for the two primary colors and
#' the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating
#' the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating
#' alternative color gradients.
#'
#' @return
Expand Down Expand Up @@ -511,7 +511,7 @@ fu_3_2023 <- fu_blues
#' of the \href{https://www.fu-berlin.de/en/index.html}{Free University Berlin}, Germany.
#'
#' See \code{\link{fu_0_2023}} for the two primary colors and
#' the \code{\link{ac}} or \code{\link[unikn]{usecol}} functions for creating
#' the \code{\link[unikn]{ac}} or \code{\link[unikn]{usecol}} functions for creating
#' alternative color gradients.
#'
#' @return
Expand Down
4 changes: 2 additions & 2 deletions R/HU_Berlin.R
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ hu_3_accent <- unikn::newpal(col = c("#e5007c", "#e30031", "#e74306",
#' The color \code{"HU blau"} is defined as \code{Pantone 294} and approximated by \code{RGB 0/55/108}.
#' Other approximations include \code{CMYK 100/60/0/20}, \code{RGB 0/51/102} (reduced web scale), and \code{RAL 270 3040}.
#'
#' See the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions
#' See the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions
#' of the \strong{unikn} package for creating color gradients.
#'
#' @return
Expand Down Expand Up @@ -507,7 +507,7 @@ hu_1_2022 <- unikn::newpal(col = c(HU_0, "white", "black"),
#' The primary color \code{"HU blue"} is defined as Pantone 294 and only approximated by RGB 0/55/108.
#' Other approximations include CMYK 100/60/0/20, RGB 0/51/102 (reduced web scale), and RAL 270 3040.
#'
#' See the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#' See the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#'
#' @return
#' A named vector of colors (HEX/HTML codes of type character).
Expand Down
2 changes: 1 addition & 1 deletion R/MPG.R
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ mpg_grey_2 <- unikn::usecol(c(mpg_grey, "white"), n = 3)[1:2]
#' }
#'
#' At \code{mpg[3]}, the color \code{"white"} was added to enable symmetrical color gradients.
#' See examples and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions
#' See examples and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions
#' for creating color gradients.
#'
#' @return
Expand Down
2 changes: 1 addition & 1 deletion R/RPTU.R
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ rptu_weiss <- "white"
#'
#' The two colors of a pair may be combined with each other.
#' When using only one color pair, shades of 10% may be used in color gradients.
#' See examples and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#' See examples and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#'
#' @return
#' A named vector of colors (HEX/HTML codes of type character).
Expand Down
4 changes: 2 additions & 2 deletions R/Uni_Bonn.R
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ ub_grau_4 <- unikn::usecol(c(ub_grau, "white"), n = 5)[1:4]
#' and \code{RAL 7030}.
#'
#' Colors shades of 75%, 50%, and 25% may be used in diagrams or visualizations.
#' See examples and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions
#' See examples and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions
#' for creating color gradients.
#'
#' @return
Expand Down Expand Up @@ -139,7 +139,7 @@ uni_bonn_1 <- unikn::newpal(col = c(ub_blau, ub_gelb, ub_grau),
#' of the \href{https://www.uni-bonn.de/en}{University of Bonn}, Germany.
#'
#' See \code{\link{uni_bonn_1}} for the definitions of the three primary colors
#' and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions
#' and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions
#' for creating color gradients.
#'
#' @return
Expand Down
6 changes: 3 additions & 3 deletions R/Uni_Freiburg.R
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ names(frbg_rosa) <- "rosa"
#' \code{Pantone 7687C}, \code{RGB 52/74/154}, \code{HEX #344a9a}, or \code{CMYK 90/75/0/0}.
#'
#' See \code{\link{uni_freiburg_1}} for a primary palette with a \code{Blau} color gradient
#' and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#' and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#'
#' @return
#' A named vector of colors (HEX/HTML codes of type character).
Expand Down Expand Up @@ -211,7 +211,7 @@ frbg_sand_name <- c("sand")
#' The gradient of \code{blau} colors is defined on \url{https://cd.uni-freiburg.de/farben/}.
#'
#' See \code{\link{uni_freiburg_0}} for the basic colors (without the \code{Blau} color gradient)
#' and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating alternative color gradients.
#' and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating alternative color gradients.
#'
#' @return
#' A named vector of colors (HEX/HTML codes of type character).
Expand Down Expand Up @@ -268,7 +268,7 @@ uni_freiburg_1 <- unikn::newpal(col = c(frbg_blues, frbg_sand_1),
#' as in \code{usecol(c(uni_freiburg_0[2], "white"), n = 6)[1:5]}.
#'
#' See \code{\link{uni_freiburg_0}} for the basic colors without the \code{Blau} color gradient
#' and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#' and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#'
#' @return
#' A named vector of colors (HEX/HTML codes of type character).
Expand Down
2 changes: 1 addition & 1 deletion R/Uni_Hamburg.R
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ steingrau_40pc <- rgb(178, 186, 189, maxColorValue = 255)
#' are used for text.
#'
#' Colors shades may be used in diagrams or visualizations.
#' See examples and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions
#' See examples and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions
#' for creating color gradients.
#'
#' @return
Expand Down
2 changes: 1 addition & 1 deletion R/Uni_Jena.R
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jena_gold <- rgb(174, 154, 99, maxColorValue = 255)
#' The auxiliary color \code{gold} is alternatively defined as
#' \code{RGB 174/154/99}, \code{CMYK 20/25/60/25}, or \code{HKS 98 K}.
#'
#' See the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions
#' See the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions
#' for creating color gradients.
#'
#' The full name of the \href{https://www.uni-jena.de}{University of Jena}
Expand Down
4 changes: 2 additions & 2 deletions R/Uni_Kiel.R
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ kiel_main <- "#9b0a7d" # = rgb(155, 10, 125, maxColorValue = 255)
#' The palette \code{uni_kiel_1} enframes this color as its central element
#' in \code{"black"} and \code{"white"} to easily enable mixing it with
#' shades of \code{"grey"}.
#' See examples and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions
#' See examples and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions
#' for creating color gradients.
#'
#' The full name of \href{https://www.uni-kiel.de/en/}{Kiel University}
Expand Down Expand Up @@ -176,7 +176,7 @@ kiel_faculty_names <- c("Theologie", "Rechtswissenschaft", "Medizin", "Philosoph
#' of \href{https://www.uni-kiel.de/en/}{Kiel University}, Germany.
#'
#' These colors may be mixed with darker shades of \code{"grey"} (or \code{"black"}).
#' See examples and the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions
#' See examples and the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions
#' for creating color gradients.
#'
#' The full name of \href{https://www.uni-kiel.de/en/}{Kiel University}
Expand Down
2 changes: 1 addition & 1 deletion R/Uni_Mannheim.R
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ UM_petrol <- rgb(65, 137, 134, maxColorValue = 255)
#' \code{RGB 0/48/86}, \code{HEX #003056}, \code{Pantone 654}, \code{CMYK 100/60/10/60}, or \code{RAL 5011}.
#'
#' The six lighter shades were created by mixing the primary \code{UM blau} with \code{"white"}.
#' See the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#' See the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#'
#' @return
#' A named vector of colors (HEX/HTML codes of type character).
Expand Down
4 changes: 2 additions & 2 deletions R/Uni_Ulm.R
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ UU_orange <- rgb(223, 109, 7, maxColorValue = 255)
#' It is alternatively defined as
#' \code{RGB 169/162/141}, \code{HEX #A9A28D}, \code{Pantone 7536 C}, or \code{CMYK 0/0/28/38}.
#'
#' See the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#' See the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#'
#' @return
#' A named vector of colors (HEX/HTML codes of type character).
Expand Down Expand Up @@ -125,7 +125,7 @@ uni_ulm_1 <- unikn::newpal(col = c("black", UU_dunkelgrau, UU_hellblau, "white",
#' \item \code{orange}: Naturwissenschaften
#' }
#'
#' See the \code{\link{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#' See the \code{\link[unikn]{ac}} and \code{\link[unikn]{usecol}} functions for creating color gradients.
#'
#' @return
#' A named vector of colors (HEX/HTML codes of type character).
Expand Down
2 changes: 1 addition & 1 deletion man/fu_1_2023.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/fu_3_2023.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/hu_1_2022.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/hu_2_2022.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/mpg.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/rptu.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_bonn_1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_bonn_2.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_freiburg_0.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_freiburg_1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_freiburg_2.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_hamburg_1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_jena_1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_kiel_1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_kiel_2.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_mannheim_1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_ulm_1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/uni_ulm_2.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3df1273

Please sign in to comment.