Setting badges up

2. Use the lifecycle::badge() function to place the badges under @description and @param blocks.

#' @description
#' `r lifecycle::badge("superseded")`
#' `top_n()` has been superseded in favour of ...

#' @param path `r lifecycle::badge("deprecated")` Use the `file` argument
#'   instead.