1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/summarizor.R
\name{summarizor}
\alias{summarizor}
\title{data summary preparation}
\usage{
summarizor(x, by = character(), overall_label = NULL)
}
\arguments{
\item{x}{dataset}
\item{by}{columns names to be used as grouping columns}
\item{overall_label}{label to use as overall label}
}
\description{
It performs a univariate statistical analysis of a dataset
by group and formats the results so that they can be used with
the \code{\link[=tabulator]{tabulator()}} function.
\if{html}{\out{
<img src="https://www.ardata.fr/img/flextable-imgs/flextable-018-square.png" alt="summarizor illustration" style="width:100\%;">
}}
}
\note{
This is very first version of the function; be aware it
can evolve or change.
}
\examples{
z <- summarizor(CO2[-c(1, 4)],
by = "Treatment",
overall_label = "Overall"
)
ft_1 <- as_flextable(z)
ft_1
# version 2 with your own functions ----
n_format <- function(n, percent) {
z <- character(length = length(n))
wcts <- !is.na(n)
z[wcts] <- sprintf("\%.0f (\%.01f \%\%)",
n[wcts], percent[wcts] * 100)
z
}
stat_format <- function(stat, num1, num2,
num1_mask = "\%.01f",
num2_mask = "(\%.01f)") {
z_num <- character(length = length(num1))
is_mean_sd <- !is.na(num1) & !is.na(num2) & stat \%in\% "mean_sd"
is_median_iqr <- !is.na(num1) & !is.na(num2) &
stat \%in\% "median_iqr"
is_range <- !is.na(num1) & !is.na(num2) & stat \%in\% "range"
is_num_1 <- !is.na(num1) & is.na(num2)
z_num[is_num_1] <- sprintf(num1_mask, num1[is_num_1])
z_num[is_mean_sd] <- paste0(
sprintf(num1_mask, num1[is_mean_sd]),
" ",
sprintf(num2_mask, num2[is_mean_sd])
)
z_num[is_median_iqr] <- paste0(
sprintf(num1_mask, num1[is_median_iqr]),
" ",
sprintf(num2_mask, num2[is_median_iqr])
)
z_num[is_range] <- paste0(
"[",
sprintf(num1_mask, num1[is_range]),
" - ",
sprintf(num1_mask, num2[is_range]),
"]"
)
z_num
}
tab_2 <- tabulator(z,
rows = c("variable", "stat"),
columns = "Treatment",
`Est.` = as_paragraph(
as_chunk(stat_format(stat, value1, value2))),
`N` = as_paragraph(as_chunk(n_format(cts, percent)))
)
ft_2 <- as_flextable(tab_2, separate_with = "variable")
ft_2
}
\seealso{
\code{\link[=fmt_summarizor]{fmt_summarizor()}}, \code{\link[=labelizor]{labelizor()}}
}
|