Skip to content

Commit

Permalink
replaced dontrun tags, documented side effects
Browse files Browse the repository at this point in the history
  • Loading branch information
daranzolin committed Dec 13, 2021
1 parent f5a296d commit c7fd2a7
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 4 deletions.
4 changes: 3 additions & 1 deletion R/print_and_pipe.R
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ print_and_pipe <- function() {
#' @param lhs
#' The left hand side of the pipe.
#' @param rhs
#' The right hand side of the pipe
#' The right hand side of the pipe.
#'
#' @return called for side effects
#'
#' @note
#' This code is experimental. Use at your own risk.
Expand Down
2 changes: 1 addition & 1 deletion R/print_pipe_steps.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#' @return The unchanged data
#'
#' @examples
#' \dontrun{
#' \donttest{
#' if (!require(dplyr)) stop("Examples need dplyr to run")
#' mtcars %>%
#' filter(am == 1) %>%
Expand Down
4 changes: 4 additions & 0 deletions R/viewPipeChain.R
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ processPipeChain <- function(cmd) {
#' in the source pane for each pipe step creating a unique object.
#' Meant to be called as an RStudio addin.
#'
#' @return No return value, called for side effects
#'
#' @export
viewPipeChain <- function() processPipeChain("View(ps%d, title = title)")

Expand All @@ -86,6 +88,8 @@ viewPipeChain <- function() processPipeChain("View(ps%d, title = title)")
#' for each pipe step the resulting object if unique. Data frames are
#' converted by as.tibble(). Meant to be called as an RStudio addin.
#'
#' @return No return value, called for side effects
#'
#' @export
printPipeChain <- function()
processPipeChain(paste("message(title);",
Expand Down
3 changes: 3 additions & 0 deletions man/printPipeChain.Rd

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

5 changes: 4 additions & 1 deletion man/print_and_pipe.Rd

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

2 changes: 1 addition & 1 deletion man/print_pipe_steps.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/viewPipeChain.Rd

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

0 comments on commit c7fd2a7

Please sign in to comment.