From b19a7c26c1a2956bb806845aca3a9997d754af14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szabolcs=20Horva=CC=81t?= Date: Fri, 19 Jan 2024 21:34:48 +0000 Subject: [PATCH] docs: move deprecation badge to top of doc pages --- R/centrality.R | 8 +++++--- man/centr_degree_tmax.Rd | 6 +++--- man/centralization.degree.tmax.Rd | 3 +-- man/estimate_betweenness.Rd | 3 ++- man/estimate_closeness.Rd | 3 ++- man/estimate_edge_betweenness.Rd | 3 ++- 6 files changed, 15 insertions(+), 11 deletions(-) diff --git a/R/centrality.R b/R/centrality.R index 27558542a9..accd2452ac 100644 --- a/R/centrality.R +++ b/R/centrality.R @@ -186,8 +186,10 @@ alpha.centrality <- function(graph, nodes = V(graph), alpha = 1, loops = FALSE, #' Deprecated version of `betweenness()` #' -#' @description Use [`betweenness()`] with the `cutoff` argument instead. +#' @description #' `r lifecycle::badge("deprecated")` +#' +#' Use [`betweenness()`] with the `cutoff` argument instead. #' @param vids The vertices for which the vertex betweenness estimation will be #' calculated. #' @inheritParams betweenness @@ -342,9 +344,9 @@ edge_betweenness <- function(graph, e = E(graph), #' Deprecated version of `edge_betweenness()` #' #' @description -#' Use [`edge_betweenness()`] with the `cutoff` argument instead. #' `r lifecycle::badge("deprecated")` #' +#' Use [`edge_betweenness()`] with the `cutoff` argument instead. #' @inheritParams edge_betweenness #' @keywords internal #' @export @@ -458,9 +460,9 @@ closeness <- function(graph, vids = V(graph), #' Deprecated version of `closeness()` #' #' @description -#' Use [`closeness()`] with the `cutoff` argument instead. #' `r lifecycle::badge("deprecated")` #' +#' Use [`closeness()`] with the `cutoff` argument instead. #' @inheritParams closeness #' @keywords internal #' @export diff --git a/man/centr_degree_tmax.Rd b/man/centr_degree_tmax.Rd index b617f8a880..62939fd6c1 100644 --- a/man/centr_degree_tmax.Rd +++ b/man/centr_degree_tmax.Rd @@ -39,13 +39,13 @@ centr_degree(g, normalized = TRUE)$centralization } \seealso{ Other centralization related: -\code{\link{centr_betw_tmax}()}, \code{\link{centr_betw}()}, -\code{\link{centr_clo_tmax}()}, +\code{\link{centr_betw_tmax}()}, \code{\link{centr_clo}()}, +\code{\link{centr_clo_tmax}()}, \code{\link{centr_degree}()}, -\code{\link{centr_eigen_tmax}()}, \code{\link{centr_eigen}()}, +\code{\link{centr_eigen_tmax}()}, \code{\link{centralize}()} } \concept{centralization related} diff --git a/man/centralization.degree.tmax.Rd b/man/centralization.degree.tmax.Rd index b71ddbe3df..d723938f0a 100644 --- a/man/centralization.degree.tmax.Rd +++ b/man/centralization.degree.tmax.Rd @@ -21,8 +21,7 @@ centralization.degree.tmax( \code{degree()}.} \item{loops}{Logical scalar, whether to consider loops edges when -calculating the degree. Currently the default value is \code{FALSE}, -but this argument will be required from igraph 1.4.0.} +calculating the degree.} } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} diff --git a/man/estimate_betweenness.Rd b/man/estimate_betweenness.Rd index ecd74a7b63..3a95e8f9ef 100644 --- a/man/estimate_betweenness.Rd +++ b/man/estimate_betweenness.Rd @@ -30,7 +30,8 @@ used by default. Weights are used to calculate weighted shortest paths, so they are interpreted as distances.} } \description{ -Use \code{\link[=betweenness]{betweenness()}} with the \code{cutoff} argument instead. \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} + +Use \code{\link[=betweenness]{betweenness()}} with the \code{cutoff} argument instead. } \keyword{internal} diff --git a/man/estimate_closeness.Rd b/man/estimate_closeness.Rd index 5670061032..0441327d3b 100644 --- a/man/estimate_closeness.Rd +++ b/man/estimate_closeness.Rd @@ -38,7 +38,8 @@ The non-normalized closeness is the inverse of the sum of distances to all reachable vertices.} } \description{ -Use \code{\link[=closeness]{closeness()}} with the \code{cutoff} argument instead. \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} + +Use \code{\link[=closeness]{closeness()}} with the \code{cutoff} argument instead. } \keyword{internal} diff --git a/man/estimate_edge_betweenness.Rd b/man/estimate_edge_betweenness.Rd index 22b8f85b8e..e83aa9a6d8 100644 --- a/man/estimate_edge_betweenness.Rd +++ b/man/estimate_edge_betweenness.Rd @@ -29,7 +29,8 @@ used by default. Weights are used to calculate weighted shortest paths, so they are interpreted as distances.} } \description{ -Use \code{\link[=edge_betweenness]{edge_betweenness()}} with the \code{cutoff} argument instead. \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} + +Use \code{\link[=edge_betweenness]{edge_betweenness()}} with the \code{cutoff} argument instead. } \keyword{internal}