From 245af9b6834d74dffb2ab957ca6d8f1f0f08d4d6 Mon Sep 17 00:00:00 2001 From: Tom Smith Date: Sat, 21 Oct 2023 16:36:02 +0100 Subject: [PATCH] ran devtools::document() --- NAMESPACE | 4 +-- man/ptd_create_ggplot.Rd | 2 +- man/ptd_create_plotly.Rd | 61 +++++++++++++++++----------------------- man/ptd_spc_colours.Rd | 2 +- man/ptd_target.Rd | 3 +- 5 files changed, 32 insertions(+), 40 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 1078efce..fab56615 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -14,6 +14,8 @@ export(ptd_rebase) export(ptd_spc) export(ptd_spc_colours) export(ptd_target) +import(rlang) +importFrom(dplyr,"%>%") importFrom(dplyr,across) importFrom(dplyr,if_all) importFrom(dplyr,if_any) @@ -24,6 +26,4 @@ importFrom(rlang,.data) importFrom(rlang,as_name) importFrom(rlang,enquo) importFrom(tidyselect,all_of) -import(rlang) -importFrom(dplyr,"%>%") importFrom(tidyselect,any_of) diff --git a/man/ptd_create_ggplot.Rd b/man/ptd_create_ggplot.Rd index e313d83a..1517455a 100644 --- a/man/ptd_create_ggplot.Rd +++ b/man/ptd_create_ggplot.Rd @@ -50,7 +50,7 @@ the y axis should be fixed for all facet plots. Accepted values are \code{TRUE} for fixed y axes or \code{FALSE} for individual y axes.} \item{x_axis_date_format}{Specify how dates on the x axis should be -displayed. The ormat should be provided as a character string using 'd m Y' +displayed. The format should be provided as a character string using 'd m Y' -type syntax.} \item{x_axis_breaks}{Specify an interval value for breaks on the x axis. diff --git a/man/ptd_create_plotly.Rd b/man/ptd_create_plotly.Rd index f3616a02..be0bf3c5 100644 --- a/man/ptd_create_plotly.Rd +++ b/man/ptd_create_plotly.Rd @@ -25,61 +25,52 @@ ptd_create_plotly( ) } \arguments{ -\item{x}{An object created by \code{\link[=ptd_spc]{ptd_spc()}}} +\item{x}{an object created by \code{\link[=ptd_spc]{ptd_spc()}}} -\item{point_size}{Specify the plotting point size for the plotly output. -The default is 4.} +\item{point_size}{Specify the plotting point size for the ggplot output. Default is 2.5.} -\item{percentage_y_axis}{Specify whether the y axis values are percentages. -Accepted values are \code{TRUE} for a percentage y axis, or \code{FALSE} for an -integer y axis. Defaults to \code{FALSE}.} +\item{percentage_y_axis}{Specify whether the y axis values are percentages. Accepted values are TRUE for percentage y +axis, FALSE for integer y axis. Defaults to FALSE.} -\item{main_title}{Specify a character string value for the plot title.} +\item{main_title}{Specify a character string value for the ggplot title.} \item{x_axis_label}{Specify a character string value for the x axis title.} \item{y_axis_label}{Specify a character string value for the y axis title.} -\item{fixed_x_axis_multiple}{Specify whether, if producing a faceted spc, -the x axis should be fixed for all facet plots. Accepted values are \code{TRUE} -for fixed x axes or \code{FALSE} for individual x axes.} +\item{fixed_x_axis_multiple}{Specify whether, if producing a faceted spc, x axis should be fixed for all facet plots. +Accepted values are TRUE for fixed x axes or FALSE for individual x axes.} -\item{fixed_y_axis_multiple}{Specify whether, if producing a faceted spc, -the y axis should be fixed for all facet plots. Accepted values are \code{TRUE} -for fixed y axes or \code{FALSE} for individual y axes.} +\item{fixed_y_axis_multiple}{Specify whether, if producing a faceted spc, y axis should be fixed for all facet plots. +Accepted values are TRUE for fixed y axes or FALSE for individual y axes.} -\item{x_axis_date_format}{Specify how dates on the x axis should be -displayed. The ormat should be provided as a character string using 'd m Y' --type syntax.} +\item{x_axis_date_format}{Specify how dates on the x axis should be displayed. Format should be provided +as a character string using 'd m Y' etc syntax.} -\item{x_axis_breaks}{Specify an interval value for breaks on the x axis. -The value should be a character string expressing interval length and type, -e.g. "3 months", "7 days".} +\item{x_axis_breaks}{Specify an interval value for breaks on the x axis. Value should be a character string +expressing interval length and type, e.g. "3 months", "7 days".} -\item{y_axis_breaks}{Specify an interval value for breaks on the y axis. -The value should be a numeric vector of length 1, either an integer for -integer scales or a decimal value for percentage scales. This option is -ignored if faceting is in use.} +\item{y_axis_breaks}{Specify an interval value for breaks on the y axis. Value should be a numeric vector of length +1, either an integer for integer scales or a decimal value for percentage scales. This option is ignored if +faceting is in use.} -\item{icons_size}{The size of the icons, defined in terms of font size. -The default is 0.15.} +\item{icons_size}{The size of the icons, defined in terms of font size. Defaults to 0.15.} -\item{icons_position}{Where to show the icons, either "top right" (default), -"bottom right", "bottom left", "top left", or "none".} +\item{icons_position}{Where to show the icons, either "top right" (default), "bottom right", "bottom left", +"top left", or "none".} -\item{colours}{Specify the colours to use in the plot. Use the -\code{\link[=ptd_spc_colours]{ptd_spc_colours()}} function to change defaults.} +\item{colours}{Specify the colours to use in the plot, use the \code{\link[=ptd_spc_colours]{ptd_spc_colours()}} function to change defaults.} -\item{theme_override}{Specify a list containing ggplot2 theme elements that -can be used to override the default appearance of the plot.} +\item{theme_override}{Specify a list containing ggplot theme elements which can be used to override the default +appearance of the plot.} -\item{break_lines}{Whether to break lines when a rebase happens. Defaults to -"both", but can break just "limits" lines, "process" lines, or "none".} +\item{break_lines}{whether to break lines when a rebase happens. Defaults to "both", but can break just "limits" +lines, "process" lines, or "none".} -\item{...}{Currently ignored} +\item{...}{currently ignored} } \value{ -A plotly object +The plotly object } \description{ Creates a plotly object using the parameters passed in. diff --git a/man/ptd_spc_colours.Rd b/man/ptd_spc_colours.Rd index 53aec98e..56fe7e9e 100644 --- a/man/ptd_spc_colours.Rd +++ b/man/ptd_spc_colours.Rd @@ -31,7 +31,7 @@ ptd_spc_colours( \item{trajectory}{the colour of the trajectory line} } \value{ -a list of colours +A list of colours } \description{ Produces a list of colours that controls the geoms in the plot diff --git a/man/ptd_target.Rd b/man/ptd_target.Rd index eed12878..3bc8aec4 100644 --- a/man/ptd_target.Rd +++ b/man/ptd_target.Rd @@ -7,7 +7,8 @@ ptd_target(...) } \arguments{ -\item{...}{Either a single values, or, named values of targets. See examples.} +\item{...}{Either a single value, or named values, of the target(s). See +examples.} } \value{ Either: