diff --git a/NAMESPACE b/NAMESPACE index ca59283..0a6075f 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -12,6 +12,7 @@ export(embiggen) export(fetch_indicators) export(format_indicator) export(label_aggregation) +export(legend) export(legend_q1) export(legend_q2) export(legend_q3) diff --git a/R/gt_helpers.R b/R/gt_helpers.R index 8c7cacf..48b59f2 100644 --- a/R/gt_helpers.R +++ b/R/gt_helpers.R @@ -143,6 +143,15 @@ legend_q2 <- 'https://github.com/USAID-OHA-SI/selfdestructin5/blob/main/man/figu #' @family gt helpers legend_q1 <- 'https://github.com/USAID-OHA-SI/selfdestructin5/blob/main/man/figures/Q1_cumulative_legend.png?raw=true' +#' Object pointing to github location of legend for Q1 +#' +#' @description +#' This helper object returns the location of the new legend. Use this version +#' The object is passed to a legend_chunk f() that creates md for the legend. +#' This can then be inserted into the subtitle as an image. +#' @export +#' @family gt helpers +legend <- 'https://github.com/USAID-OHA-SI/selfdestructin5/blob/main/man/figures/legend.png?raw=true' #' Make all text larger diff --git a/man/authors_footnote.Rd b/man/authors_footnote.Rd index 18a40f2..e1fba0d 100644 --- a/man/authors_footnote.Rd +++ b/man/authors_footnote.Rd @@ -28,6 +28,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/bold_rowgroup.Rd b/man/bold_rowgroup.Rd index 52074d8..c20207f 100644 --- a/man/bold_rowgroup.Rd +++ b/man/bold_rowgroup.Rd @@ -37,6 +37,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/caveats_footnote.Rd b/man/caveats_footnote.Rd index f17cae6..04c986d 100644 --- a/man/caveats_footnote.Rd +++ b/man/caveats_footnote.Rd @@ -22,6 +22,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/change_footnote.Rd b/man/change_footnote.Rd index 6517367..2f47064 100644 --- a/man/change_footnote.Rd +++ b/man/change_footnote.Rd @@ -22,6 +22,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/create_pd.Rd b/man/create_pd.Rd index f8e99aa..c30ec82 100644 --- a/man/create_pd.Rd +++ b/man/create_pd.Rd @@ -29,6 +29,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/dedup_footnote.Rd b/man/dedup_footnote.Rd index d0c3ac7..38586d5 100644 --- a/man/dedup_footnote.Rd +++ b/man/dedup_footnote.Rd @@ -22,6 +22,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/delta_footnote.Rd b/man/delta_footnote.Rd index 0623425..cd31f08 100644 --- a/man/delta_footnote.Rd +++ b/man/delta_footnote.Rd @@ -22,6 +22,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/extract_num_colnames.Rd b/man/extract_num_colnames.Rd index b091596..27a42e6 100644 --- a/man/extract_num_colnames.Rd +++ b/man/extract_num_colnames.Rd @@ -29,6 +29,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/figures/legend.png b/man/figures/legend.png index c7dcfc8..f149a64 100644 Binary files a/man/figures/legend.png and b/man/figures/legend.png differ diff --git a/man/legend.Rd b/man/legend.Rd new file mode 100644 index 0000000..5508a1b --- /dev/null +++ b/man/legend.Rd @@ -0,0 +1,38 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/gt_helpers.R +\docType{data} +\name{legend} +\alias{legend} +\title{Object pointing to github location of legend for Q1} +\format{ +An object of class \code{character} of length 1. +} +\usage{ +legend +} +\description{ +This helper object returns the location of the new legend. Use this version +The object is passed to a legend_chunk f() that creates md for the legend. +This can then be inserted into the subtitle as an image. +} +\seealso{ +Other gt helpers: +\code{\link{authors_footnote}()}, +\code{\link{bold_rowgroup}()}, +\code{\link{caveats_footnote}()}, +\code{\link{change_footnote}()}, +\code{\link{create_pd}()}, +\code{\link{dedup_footnote}()}, +\code{\link{delta_footnote}()}, +\code{\link{extract_num_colnames}()}, +\code{\link{legend_q1}}, +\code{\link{legend_q2}}, +\code{\link{legend_q3}}, +\code{\link{legend_snapshot}}, +\code{\link{past_fy}()}, +\code{\link{present_fy}()}, +\code{\link{present_qtr}()}, +\code{\link{vlc_footnote}()} +} +\concept{gt helpers} +\keyword{datasets} diff --git a/man/legend_q1.Rd b/man/legend_q1.Rd index 015b814..673ec00 100644 --- a/man/legend_q1.Rd +++ b/man/legend_q1.Rd @@ -28,6 +28,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/legend_q2.Rd b/man/legend_q2.Rd index d13d7f8..e2caa81 100644 --- a/man/legend_q2.Rd +++ b/man/legend_q2.Rd @@ -28,6 +28,7 @@ Other gt helpers: \code{\link{legend_q1}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/legend_q3.Rd b/man/legend_q3.Rd index 4e31667..26903c1 100644 --- a/man/legend_q3.Rd +++ b/man/legend_q3.Rd @@ -28,6 +28,7 @@ Other gt helpers: \code{\link{legend_q1}}, \code{\link{legend_q2}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/legend_snapshot.Rd b/man/legend_snapshot.Rd index e483969..17eb2b4 100644 --- a/man/legend_snapshot.Rd +++ b/man/legend_snapshot.Rd @@ -28,6 +28,7 @@ Other gt helpers: \code{\link{legend_q1}}, \code{\link{legend_q2}}, \code{\link{legend_q3}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, diff --git a/man/past_fy.Rd b/man/past_fy.Rd index 7004f7e..8e30a70 100644 --- a/man/past_fy.Rd +++ b/man/past_fy.Rd @@ -29,6 +29,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}, \code{\link{vlc_footnote}()} diff --git a/man/present_fy.Rd b/man/present_fy.Rd index 82f70c4..3d28f26 100644 --- a/man/present_fy.Rd +++ b/man/present_fy.Rd @@ -29,6 +29,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_qtr}()}, \code{\link{vlc_footnote}()} diff --git a/man/present_qtr.Rd b/man/present_qtr.Rd index bb3e9e9..daaa167 100644 --- a/man/present_qtr.Rd +++ b/man/present_qtr.Rd @@ -29,6 +29,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{vlc_footnote}()} diff --git a/man/vlc_footnote.Rd b/man/vlc_footnote.Rd index 73267a0..f138480 100644 --- a/man/vlc_footnote.Rd +++ b/man/vlc_footnote.Rd @@ -23,6 +23,7 @@ Other gt helpers: \code{\link{legend_q2}}, \code{\link{legend_q3}}, \code{\link{legend_snapshot}}, +\code{\link{legend}}, \code{\link{past_fy}()}, \code{\link{present_fy}()}, \code{\link{present_qtr}()}