docs: fix false subtype= claim in All Categories roxygen (F1)
The @param category text on cog_spending()/cog_revenue() told users to "Combine with subtype = ..." but neither verb has a subtype argument. Replace with accurate guidance: filter the returned frame's spend_subtype/revenue_subtype column.
This commit is contained in:
+3
-2
@@ -16,8 +16,9 @@
|
|||||||
#' combined with other category names, and it is not the same thing as
|
#' combined with other category names, and it is not the same thing as
|
||||||
#' `revenue_concept = "total"`: the concept chooses which subtypes are in
|
#' `revenue_concept = "total"`: the concept chooses which subtypes are in
|
||||||
#' scope, `"All Categories"` chooses whether rows inside that scope are
|
#' scope, `"All Categories"` chooses whether rows inside that scope are
|
||||||
#' broken out or summed. Combine with `subtype = "operations"` for an
|
#' broken out or summed. Because the result keeps one row per
|
||||||
#' own-source revenue total.
|
#' `revenue_subtype`, filtering the returned frame to
|
||||||
|
#' `revenue_subtype == "own_source"` gives an own-source revenue total.
|
||||||
#' @param revenue_concept Which of Census's two published revenue concepts to
|
#' @param revenue_concept Which of Census's two published revenue concepts to
|
||||||
#' return. Concepts are defined as sets of the crosswalk's `revenue_subtype`
|
#' return. Concepts are defined as sets of the crosswalk's `revenue_subtype`
|
||||||
#' values -- never as item-code first letters, which cannot classify
|
#' values -- never as item-code first letters, which cannot classify
|
||||||
|
|||||||
+3
-2
@@ -78,8 +78,9 @@
|
|||||||
#' combined with other category names, and it is not the same thing as
|
#' combined with other category names, and it is not the same thing as
|
||||||
#' `expenditure_concept = "total"`: the concept chooses which subtypes are in
|
#' `expenditure_concept = "total"`: the concept chooses which subtypes are in
|
||||||
#' scope, `"All Categories"` chooses whether rows inside that scope are
|
#' scope, `"All Categories"` chooses whether rows inside that scope are
|
||||||
#' broken out or summed. Combine with `subtype = "operations"` for an
|
#' broken out or summed. Because the result keeps one row per
|
||||||
#' operating-expenditure total.
|
#' `spend_subtype`, filtering the returned frame to
|
||||||
|
#' `spend_subtype == "operations"` gives an operating-expenditure total.
|
||||||
#' @param per_capita If `TRUE`, adds `amt_per_capita_nominal` (and
|
#' @param per_capita If `TRUE`, adds `amt_per_capita_nominal` (and
|
||||||
#' `amt_per_capita_real` when `adjust_to_year` is set) using the per-year
|
#' `amt_per_capita_real` when `adjust_to_year` is set) using the per-year
|
||||||
#' Census F-33 population from `gov_population_yearly`. Result also gains
|
#' Census F-33 population from `gov_population_yearly`. Result also gains
|
||||||
|
|||||||
+3
-2
@@ -29,8 +29,9 @@ category inside the requested concept's subtype scope. It cannot be
|
|||||||
combined with other category names, and it is not the same thing as
|
combined with other category names, and it is not the same thing as
|
||||||
`revenue_concept = "total"`: the concept chooses which subtypes are in
|
`revenue_concept = "total"`: the concept chooses which subtypes are in
|
||||||
scope, `"All Categories"` chooses whether rows inside that scope are
|
scope, `"All Categories"` chooses whether rows inside that scope are
|
||||||
broken out or summed. Combine with `subtype = "operations"` for an
|
broken out or summed. Because the result keeps one row per
|
||||||
own-source revenue total.}
|
`revenue_subtype`, filtering the returned frame to
|
||||||
|
`revenue_subtype == "own_source"` gives an own-source revenue total.}
|
||||||
|
|
||||||
\item{per_capita}{If `TRUE`, adds `amt_per_capita_nominal` (and
|
\item{per_capita}{If `TRUE`, adds `amt_per_capita_nominal` (and
|
||||||
`amt_per_capita_real` when `adjust_to_year` is set) using the per-year
|
`amt_per_capita_real` when `adjust_to_year` is set) using the per-year
|
||||||
|
|||||||
+3
-2
@@ -29,8 +29,9 @@ category inside the requested concept's subtype scope. It cannot be
|
|||||||
combined with other category names, and it is not the same thing as
|
combined with other category names, and it is not the same thing as
|
||||||
`expenditure_concept = "total"`: the concept chooses which subtypes are in
|
`expenditure_concept = "total"`: the concept chooses which subtypes are in
|
||||||
scope, `"All Categories"` chooses whether rows inside that scope are
|
scope, `"All Categories"` chooses whether rows inside that scope are
|
||||||
broken out or summed. Combine with `subtype = "operations"` for an
|
broken out or summed. Because the result keeps one row per
|
||||||
operating-expenditure total.}
|
`spend_subtype`, filtering the returned frame to
|
||||||
|
`spend_subtype == "operations"` gives an operating-expenditure total.}
|
||||||
|
|
||||||
\item{per_capita}{If `TRUE`, adds `amt_per_capita_nominal` (and
|
\item{per_capita}{If `TRUE`, adds `amt_per_capita_nominal` (and
|
||||||
`amt_per_capita_real` when `adjust_to_year` is set) using the per-year
|
`amt_per_capita_real` when `adjust_to_year` is set) using the per-year
|
||||||
|
|||||||
Reference in New Issue
Block a user