Skip to content

Commit

Permalink
update Rd files
Browse files Browse the repository at this point in the history
  • Loading branch information
Kirill Müller committed Jan 6, 2014
1 parent 4094566 commit 940407d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
6 changes: 5 additions & 1 deletion man/ldply.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
\title{Split list, apply function, and return results in a data frame.}
\usage{
ldply(.data, .fun = NULL, ..., .progress = "none", .inform = FALSE,
.parallel = FALSE, .paropts = NULL)
.parallel = FALSE, .paropts = NULL, .id = ".id")
}
\arguments{
\item{.fun}{function to apply to each piece}
Expand All @@ -29,6 +29,10 @@ ldply(.data, .fun = NULL, ..., .progress = "none", .inform = FALSE,
slows processing speed, but is very useful for debugging}

\item{.data}{list to be processed}

\item{.id}{name of the index column (used if \code{.data}
is a named list), defaults to \code{".id"}. Pass
\code{NULL} to avoid creation of the index column}
}
\value{
A data frame, as described in the output section.
Expand Down
5 changes: 4 additions & 1 deletion man/list_to_dataframe.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@
\alias{list_to_dataframe}
\title{List to data frame.}
\usage{
list_to_dataframe(res, labels = NULL)
list_to_dataframe(res, labels = NULL, idname = NULL)
}
\arguments{
\item{res}{list of input data}

\item{labels}{a data frame of labels, one row for each
element of res}

\item{idname}{the name of the index column, \code{NULL}
for no index column}
}
\description{
Reduce/simplify a list of homogenous objects to a data
Expand Down
6 changes: 5 additions & 1 deletion man/rdply.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
\alias{rdply}
\title{Replicate expression and return results in a data frame.}
\usage{
rdply(.n, .expr, .progress = "none")
rdply(.n, .expr, .progress = "none", .id = ".n")
}
\arguments{
\item{.n}{number of times to evaluate the expression}
Expand All @@ -11,6 +11,10 @@ rdply(.n, .expr, .progress = "none")

\item{.progress}{name of the progress bar to use, see
\code{\link{create_progress_bar}}}

\item{.id}{name of the index column, defaults to
\code{".n"}. Pass \code{NULL} to avoid creation of the
index column}
}
\value{
a data frame
Expand Down

0 comments on commit 940407d

Please sign in to comment.