Skip to content

Commit 14c5eca

Browse files
committed
Add pipe documentation
1 parent 169464e commit 14c5eca

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

R/utils-pipe.R

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
#' Pipe operator
22
#'
3-
#' See \code{magrittr::\link[magrittr]{\%>\%}} for details.
3+
#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
44
#'
55
#' @name %>%
66
#' @rdname pipe
77
#' @keywords internal
88
#' @export
99
#' @importFrom magrittr %>%
1010
#' @usage lhs \%>\% rhs
11+
#' @param lhs A value or the magrittr placeholder.
12+
#' @param rhs A function call using the magrittr semantics.
13+
#' @return The result of calling `rhs(lhs)`.
1114
NULL

man/pipe.Rd

+9-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)