Export *compute_profile_ranking() as internal (#791)

* Export internal spa_compute_profile_ranking

* Bump

* Polish NEWS

Author: maurolepore

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: tiltIndicator
 Title: Indicators for the 'TILT' Project
-Version: 0.0.0.9223
+Version: 0.0.0.9224
 Authors@R: c(
     person("Mauro", "Lepore", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "https://orcid.org/0000-0002-1986-7988")),

NAMESPACE

@@ -20,6 +20,7 @@ export(emissions_profile_any_compute_profile_ranking)
 export(emissions_profile_upstream)
 export(enquo)
 export(enquos)
+export(epa_compute_profile_ranking)
 export(example_companies)
 export(example_data_factory)
 export(example_dictionary)
@@ -46,6 +47,7 @@ export(sector_profile_any_polish_output_at_company_level)
 export(sector_profile_any_prepare_scenario)
 export(sector_profile_any_prune_companies)
 export(sector_profile_upstream)
+export(spa_compute_profile_ranking)
 export(summarize_range)
 export(tilt_profile)
 export(unnest_company)

NEWS.md

@@ -1,5 +1,11 @@
 <!-- NEWS.md is maintained by https://cynkra.github.io/fledge, do not edit -->
 
+# tiltIndicator 0.0.0.9224 (2024-06-03)
+
+* `spa_compute_profile_ranking()` and `spa_compute_profile_ranking()` is now
+exported as internal, and documented along with `epa_compute_profile_ranking()`
+under the topic `?spa_compute_profile_ranking` (#791).
+
 # tiltIndicator 0.0.0.9223 (2024-05-20)
 
 * `sector_profile()` now accounts for unmatched `type`, `sector` or `subsector`

R/epa_compute_profile_ranking.R renamed to R/compute_profile_ranking.R

@@ -1,42 +1,23 @@
-#' Add values to categorize
-#'
-#' @description
-#' `r lifecycle::badge("deprecated")`
-#'
-#' This function was deprecated because it's internal. Users don't need to
-#' interact with the function itself.
-#'
-#' @param data A "co2-like" data frame -- i.e. containing products or
-#'   upstream-products (a.k.a. inputs).
+#' Compute profile ranking
 #'
+#' @name compute_profile_ranking
 #' @keywords internal
-#'
-#' @return The input data frame with the additional columns `grouped_by` and
-#'   `profile_ranking` and one row per benchmark per company.
-#'
+NULL
+
+#' @rdname compute_profile_ranking
 #' @export
-#'
-#' @examples
-#' library(tiltToyData)
-#' library(readr, warn.conflicts = FALSE)
-#' options(readr.show_col_types = FALSE)
-#'
-#' companies <- read_csv(toy_emissions_profile_any_companies())
-#'
-#' products <- read_csv(toy_emissions_profile_products_ecoinvent())
-#' products |> emissions_profile_any_compute_profile_ranking()
-#'
-#' inputs <- read_csv(toy_emissions_profile_upstream_products_ecoinvent())
-#' inputs |> emissions_profile_any_compute_profile_ranking()
-emissions_profile_any_compute_profile_ranking <- function(data) {
-  lifecycle::deprecate_warn(
-    "0.0.0.9109",
-    "emissions_profile_any_compute_profile_ranking()",
-    details = "This function is now internal."
+#' @keywords internal
+spa_compute_profile_ranking <- function(data, scenarios) {
+  left_join(
+    data, scenarios,
+    by = c(aka("scenario_type"), aka("xsector"), aka("xsubsector")),
+    relationship = "many-to-many"
   )
-  epa_compute_profile_ranking(data)
 }
 
+#' @rdname compute_profile_ranking
+#' @export
+#' @keywords internal
 epa_compute_profile_ranking <- function(data) {
   check_epa_compute_profile_ranking(data)
 

R/emissions_profile_any_compute_profile_ranking.R

@@ -0,0 +1,38 @@
+#' Add values to categorize
+#'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' This function was deprecated because it's internal. Users don't need to
+#' interact with the function itself.
+#'
+#' @param data A "co2-like" data frame -- i.e. containing products or
+#'   upstream-products (a.k.a. inputs).
+#'
+#' @keywords internal
+#'
+#' @return The input data frame with the additional columns `grouped_by` and
+#'   `profile_ranking` and one row per benchmark per company.
+#'
+#' @export
+#'
+#' @examples
+#' library(tiltToyData)
+#' library(readr, warn.conflicts = FALSE)
+#' options(readr.show_col_types = FALSE)
+#'
+#' companies <- read_csv(toy_emissions_profile_any_companies())
+#'
+#' products <- read_csv(toy_emissions_profile_products_ecoinvent())
+#' products |> emissions_profile_any_compute_profile_ranking()
+#'
+#' inputs <- read_csv(toy_emissions_profile_upstream_products_ecoinvent())
+#' inputs |> emissions_profile_any_compute_profile_ranking()
+emissions_profile_any_compute_profile_ranking <- function(data) {
+  lifecycle::deprecate_warn(
+    "0.0.0.9109",
+    "emissions_profile_any_compute_profile_ranking()",
+    details = "This function is now internal."
+  )
+  epa_compute_profile_ranking(data)
+}

R/spa.R

@@ -45,14 +45,6 @@ prepare_scenarios <- function(data, low_threshold, high_threshold) {
     rename(profile_ranking = aka("co2reduce"))
 }
 
-spa_compute_profile_ranking <- function(data, scenarios) {
-  left_join(
-    data, scenarios,
-    by = c(aka("scenario_type"), aka("xsector"), aka("xsubsector")),
-    relationship = "many-to-many"
-  )
-}
-
 spa_polish_output_at_product_level <- function(data) {
   data |>
     ungroup() |>