list_wrap: Returns a function that coerces the return values of f to a...
In rtables: Reporting Tables
list_wrap_x R Documentation
Returns a function that coerces the return values of f to a list
Description
Returns a function that coerces the return values of f to a list
Usage
list_wrap_x(f)
list_wrap_df(f)
Arguments
f
The function to wrap.
Details
list_wrap_x generates a wrapper which takes x as its
first argument, while list_wrap_df generates an otherwise identical
wrapper function whose first argument is named df.
We provide both because when using the functions as tabulation in
analyze, functions which take df as their first
argument are passed the full subset dataframe, while those which accept
anything else notably including x are passed only the relevant
subset of the variable being analyzed.
Value
A function which calls f and converts the result to a list of
CellValue objects.
Author(s)
Gabriel Becker
Examples
summary(iris$Sepal.Length)
f <- list_wrap_x(summary)
f(x = iris$Sepal.Length)
f2 <- list_wrap_df(summary)
f2(df = iris$Sepal.Length)
rtables documentation built on Aug. 30, 2023, 5:07 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| list_wrap_x | R Documentation |
Returns a function that coerces the return values of f to a list
Description
Returns a function that coerces the return values of f to a list
Usage
list_wrap_x(f)
list_wrap_df(f)
Arguments
f |
The function to wrap. |
Details
list_wrap_x generates a wrapper which takes x as its
first argument, while list_wrap_df generates an otherwise identical
wrapper function whose first argument is named df.
We provide both because when using the functions as tabulation in
analyze, functions which take df as their first
argument are passed the full subset dataframe, while those which accept
anything else notably including x are passed only the relevant
subset of the variable being analyzed.
Value
A function which calls f and converts the result to a list of
CellValue objects.
Author(s)
Gabriel Becker
Examples
summary(iris$Sepal.Length)
f <- list_wrap_x(summary)
f(x = iris$Sepal.Length)
f2 <- list_wrap_df(summary)
f2(df = iris$Sepal.Length)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.