Skip to content

Commit fa54f56

Browse files
committed
doc fixes
1 parent 2e57f74 commit fa54f56

4 files changed

Lines changed: 14 additions & 5 deletions

File tree

R/flatten.r

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
#' Flattens an array along an axis
22
#'
3-
#' @param X Array
3+
#' @param x Array
44
#' @param along Along which axis to bind them together (default: last)
55
#' @param name_sep Which character to use for naming new arrays [default: NA, do not touch names]
66
#' @return An array with n-1 dimensions
77
#' @export
8-
flatten = function(X, along=-1, name_sep=NA) {
8+
flatten = function(x, along=-1, name_sep=NA) {
99
if (along == -1)
1010
along = length(dim(x))
1111

12-
re = split(X, along=along, drop=TRUE)
12+
re = split(x, along=along, drop=TRUE)
1313

1414
if (!is.na(name_sep))
1515
re = mapply(function(x, n) {

R/util.r

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@ guess_structure = function(df, verbose=TRUE) {
8888
}
8989

9090
#' Return a list of named dot-arguments
91+
#'
92+
#' @param ... Function arguments
93+
#' @return Named function arguments
9194
named_dots = function(...) {
9295
dots = eval(substitute(alist(...)))
9396
dnames = names(dots) %or% rep("", length(dots))

man/flatten.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/named_dots.Rd

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)