From 5de8399ed4cb4445f47b1e3b5aff8b7a7a8dabc3 Mon Sep 17 00:00:00 2001 From: Sebastian Fox Date: Thu, 14 Nov 2019 10:12:24 +0000 Subject: [PATCH] Improved documentation for trend option in aera_profiles --- R/quick_charts.R | 9 ++++++++- man/area_profiles.Rd | 9 ++++++++- man/create_datatable.Rd | 9 ++++++++- 3 files changed, 24 insertions(+), 3 deletions(-) diff --git a/R/quick_charts.R b/R/quick_charts.R index b2b91d8..2628f73 100644 --- a/R/quick_charts.R +++ b/R/quick_charts.R @@ -905,7 +905,14 @@ map <- function(data, ons_api, area_code, fill, type = "static", value, name_for #' @param timeperiod unquoted field name of the time period field #' @param trend unquoted field name of the trend field; if the user doesn't want #' to display trend information then leave this incomplete and amend the -#' header_labels argument to remove the Trend header +#' header_labels argument to remove the Trend header. Text within this field +#' should contain one of the following words to control the arrows that are +#' displayed; "decreasing", "increasing", "no significant change", "could not +#' be calculated". The text within this field should contain one of the +#' following words to control the colour; "better", "worse", "no significant +#' change". If none of these words appear in the string, the words +#' "increasing" or "decreasing" will be used to colour the arrows in different +#' shades of blue" #' @param polarity unquoted field name containing the polarity information #' (currently only handles polarity returned by fingertipsR package) #' @param significance unquoted field name describing the statistical diff --git a/man/area_profiles.Rd b/man/area_profiles.Rd index 4f9f04d..8962d85 100644 --- a/man/area_profiles.Rd +++ b/man/area_profiles.Rd @@ -45,7 +45,14 @@ but data exist for multiple sub-categories (for example, sex or age)} \item{trend}{unquoted field name of the trend field; if the user doesn't want to display trend information then leave this incomplete and amend the -header_labels argument to remove the Trend header} +header_labels argument to remove the Trend header. Text within this field +should contain one of the following words to control the arrows that are +displayed; "decreasing", "increasing", "no significant change", "could not +be calculated". The text within this field should contain one of the +following words to control the colour; "better", "worse", "no significant +change". If none of these words appear in the string, the words +"increasing" or "decreasing" will be used to colour the arrows in different +shades of blue"} \item{polarity}{unquoted field name containing the polarity information (currently only handles polarity returned by fingertipsR package)} diff --git a/man/create_datatable.Rd b/man/create_datatable.Rd index e6d0dc1..73f9a1c 100644 --- a/man/create_datatable.Rd +++ b/man/create_datatable.Rd @@ -26,7 +26,14 @@ should all exist in this field)} \item{trend}{unquoted field name of the trend field; if the user doesn't want to display trend information then leave this incomplete and amend the -header_labels argument to remove the Trend header} +header_labels argument to remove the Trend header. Text within this field +should contain one of the following words to control the arrows that are +displayed; "decreasing", "increasing", "no significant change", "could not +be calculated". The text within this field should contain one of the +following words to control the colour; "better", "worse", "no significant +change". If none of these words appear in the string, the words +"increasing" or "decreasing" will be used to colour the arrows in different +shades of blue"} \item{count}{unquoted field name where the count (numerator) is stored}