Skip to content

Commit

Permalink
Make sure all functions have an example and return value
Browse files Browse the repository at this point in the history
  • Loading branch information
Olivia-Box-Power committed Feb 6, 2025
1 parent c771574 commit 3093e00
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 0 deletions.
4 changes: 4 additions & 0 deletions R/addin.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
#' Insert at the cursor a template for \code{\link{create_aftable}} from the
#' 'aftable' package, pre-filled with demo data.
#'
#' @return Empty list. Function is used for side effect.
#'
#' @export
at_template_aftable <- function() {
rstudioapi::insertText(string_create_aftable())
Expand All @@ -14,6 +16,8 @@ at_template_aftable <- function() {
#' tables, and (b) a call to \code{\link{create_aftable}} pre-filled with
#' demo data.
#'
#' @return Empty list. Function is used for side effect.
#'
#' @export
at_template_workflow <- function() {

Expand Down
3 changes: 3 additions & 0 deletions R/aftable.R
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ create_aftable <- function(tab_titles,
#' aftable, otherwise \code{FALSE}.
#'
#' @examples
#' as_aftable(demo_df)
#' is_aftable(demo_aftable)
#'
#' @export
Expand Down Expand Up @@ -245,6 +246,8 @@ is_aftable <- function(x) {
#' @param object An aftable-class object for which to get a summary.
#' @param ... Other arguments to pass.
#'
#' @return `object` unaltered.
#'
#' @examples
#' # Print a concise summary of the aftable-class object
#' summary(demo_aftable)
Expand Down
1 change: 1 addition & 0 deletions man/as_aftable.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/at_template_aftable.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/at_template_workflow.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/summary.aftable.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3093e00

Please sign in to comment.