Describe function outputs

R/add_pvalue.R

@@ -60,6 +60,9 @@
 #' @param ... Additional aesthetics or arguments passed to
 #' \code{\link[ggplot2]{layer}}. See below for allowed values.
 #'
+#' @return Returns a _layer_ ggproto object with either `geom = GeomBracket` or
+#' `geom = GeomText`.
+#'
 #' @section Allowed ... values:
 #' `add_pvalue` understands the following additional aesthetics or arguments:
 #'

R/annotation_ticks.R

@@ -33,6 +33,8 @@
 #' faceting variable you want to annotate specifically.
 #' See [here](https://stackoverflow.com/questions/20128582) for an example.
 #'
+#' @return Returns a _layer_ ggproto object with `geom = GeomTicks`.
+#'
 #' @example inst/examples/ex-annotation_ticks.R
 #'
 #' @export

R/guide_prism_bracket.R

@@ -12,6 +12,8 @@
 #' outwards. If `FALSE` the bracket crossbar is moved so the ticks appear
 #' to point inwards towards the plotting area.
 #'
+#' @return Returns a \emph{prism_bracket} guide class object.
+#'
 #' @example inst/examples/ex-guide_prism_bracket.R
 #'
 #' @export

R/guide_prism_minor.R

@@ -12,6 +12,8 @@
 #'
 #' @inheritParams ggplot2::guide_axis
 #'
+#' @return Returns a \emph{prism_minor} guide class object.
+#'
 #' @example inst/examples/ex-guide_prism_minor.R
 #'
 #' @export

R/guide_prism_offset.R

@@ -8,6 +8,8 @@
 #'
 #' @inheritParams ggplot2::guide_axis
 #'
+#' @return Returns a \emph{prism_offset} guide class object.
+#'
 #' @example inst/examples/ex-guide_prism_offset.R
 #'
 #' @export

R/guide_prism_offset_minor.R

@@ -15,6 +15,8 @@
 #'
 #' @inheritParams ggplot2::guide_axis
 #'
+#' @return Returns a \emph{prism_offset_minor} guide class object.
+#'
 #' @example inst/examples/ex-guide_prism_offset_minor.R
 #'
 #' @export

R/preview_theme.R

@@ -5,6 +5,8 @@
 #'
 #' @param palette `string`. Palette name.
 #'
+#' @return Returns an object of class _ggplot_.
+#'
 #' @example inst/examples/ex-preview_theme.R
 #'
 #' @export

R/prism_colour_pal.R

@@ -4,6 +4,9 @@
 #' colour schemes available in GraphPad Prism.
 #'
 #' @inheritParams scale_colour_prism
+#' @return Returns a function which takes a single integer as its only argument
+#' and returns a character vector of hexadecimal colours.
+#' See the examples below for usage.
 #' @example inst/examples/ex-prism_colour_pal.R
 #' @export
 prism_colour_pal <- function(palette = "colors") {

R/prism_fill_pal.R

@@ -4,6 +4,9 @@
 #' colour schemes available in GraphPad Prism.
 #'
 #' @inheritParams scale_fill_prism
+#' @return Returns a function which takes a single integer as its only argument
+#' and returns a character vector of hexadecimal colours.
+#' See the examples below for usage.
 #' @example inst/examples/ex-prism_fill_pal.R
 #' @export
 prism_fill_pal <- function(palette = "colors") {

R/prism_shape_pal.R

@@ -13,6 +13,10 @@
 #' have a fill.
 #'
 #' @inheritParams scale_shape_prism
+#' @return Returns a function which takes a single integer as its only argument
+#' and returns a character vector of integers which correspond to R plot pch
+#' symbols.
+#' See the examples below for usage.
 #' @example inst/examples/ex-prism_shape_pal.R
 #' @export
 prism_shape_pal <- function(palette = c("default", "filled", "complete")) {

R/scale_colour_prism.R

@@ -8,6 +8,9 @@
 #' and their number of values each palette supports.
 #' @inheritDotParams ggplot2::discrete_scale -aesthetics -scale_name
 #'
+#' @return Returns a ggproto object of class _ScaleDiscrete_ which works with
+#' _colour_ aesthetics.
+#'
 #' @example inst/examples/ex-scale_colour_prism.R
 #'
 #' @export

R/scale_fill_prism.R

@@ -8,6 +8,9 @@
 #' for valid palette names.
 #' @inheritDotParams ggplot2::discrete_scale -aesthetics -scale_name
 #'
+#' @return Returns a ggproto object of class _ScaleDiscrete_ which works with
+#' _fill_ aesthetics.
+#'
 #' @example inst/examples/ex-scale_fill_prism.R
 #'
 #' @export

R/scale_shape_prism.R

@@ -16,6 +16,9 @@
 #' `filled`, or `complete`.
 #' @inheritDotParams ggplot2::discrete_scale -aesthetics -scale_name
 #'
+#' @return Returns a ggproto object of class _ScaleDiscrete_ which works with
+#' _shape_ aesthetics.
+#'
 #' @example inst/examples/ex-scale_shape_prism.R
 #'
 #' @export

R/theme_prism.R

@@ -15,6 +15,8 @@
 #' @param border `logical`. Should a border be drawn around the plot?
 #' Clipping will occur unless e.g. `coord_cartesian(clip = "off")` is used.
 #'
+#' @return Returns a list-like object of class _theme_.
+#'
 #' @example inst/examples/ex-theme_prism.R
 #'
 #' @export