This package aims to speed up research projects in social psychology (and related fields). For that, it primarily includes some functions that help lay the groundwork and others that facilitate the reporting of results.
Among others, the package can help with the following:
There are many packages that support data analysis and reporting. For
instance, the psych
package offers functions to create scales, while
the modelsummary
package offers options to create customisable tables
in a wide variety of output format. They power many of the functions
offered here ‘under the hood.’
apa
and papaja
are two packages that directly support the reporting
of results in APA style - they can complement this package well.
However, none of the existing offered quite what we needed. This package
tidyverse
by supporting tidy evaluation and
returning tibbles where possibleYou can install timesaveR from GitHub with the command below. If you do
not have the remotes
-package installed, run
install.packages("remote")
first.
remotes::install_github('lukaswallrich/timesaveR')
There are many functions in the package, and we will create vignettes detailing various use cases. However, the following can give you an initial flavor. The examples use data from the European Social Survey Wave 7 (2014). Here, I ignore survey weights. However, the package offers similar functions for analysing weighted survey data, which are explained in the survey data vignette.
(I also load dplyr
since that is the recommended usage - of course,
there are base R alternatives for all of the steps.)
library(dplyr)
#>
#> Attaching package: 'dplyr'
#> The following objects are masked from 'package:stats':
#>
#> filter, lag
#> The following objects are masked from 'package:base':
#>
#> intersect, setdiff, setequal, union
library(timesaveR)
#> Note re timesaveR: Many functions in this package are alpha-versions - please treat results with care and report bugs and desired features.
Let’s create scales for health behaviours and depressive symptoms, each including some reverse coding.
scales <- list(
depression = c("fltdpr", "flteeff", "slprl", "wrhpp", "fltlnl",
"enjlf", "fltsd", "cldgng"),
healthy_eating = c("etfruit", "eatveg")
)
scales_reverse <- list(
depression = c("wrhpp", "enjlf"),
healthy_eating = c("etfruit", "eatveg")
)
scales <- make_scales(ess_health, items = scales, reversed = scales_reverse)
#> The following scales will be calculated with specified reverse coding: depression, healthy_eating
#Check descriptives, including reliability
scales$descriptives
#> # A tibble: 2 × 10
#> Scale n_items reliability reliability_method mean SD reversed rev_min
#> <chr> <int> <dbl> <chr> <dbl> <dbl> <chr> <dbl>
#> 1 depression 8 0.802 cronbachs_alpha 1.67 0.484 wrhpp e… 1
#> 2 healthy_e… 2 0.658 spearman_brown 4.97 1.11 etfruit… 1
#> # ℹ 2 more variables: rev_max <dbl>, text <chr>
#Add scale scores to dataset
ess_health <- bind_cols(ess_health, scales$scores)
Next, we are often interested in descriptive statistics, variable distributions and correlations.
ess_health %>% select(agea, health, depression, healthy_eating) %>%
cor_matrix() %>% report_cor_table()
50.61 (18.51)
2.26 (0.92)
.28 ***[0.25, 0.30]
1.67 (0.48)
.03 *[0.00, 0.05]
.42 ***[0.40, 0.44]
4.97 (1.11)
.17 ***[0.15, 0.19]
-.09 ***[-0.11, -0.07]
-.13 ***[-0.15, -0.10]
var_renames <- tibble::tribble( ~old, ~new, "agea", "Age", "health", "Poor health", "depression", "Depression", "healthy_eating", "Healthy eating", )
ess_health %>% cor_matrix(var_names = var_renames) %>% report_cor_table()
<tr class="gt_col_headings">
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="Variable">Variable</th>
<th class="gt_col_heading gt_columns_bottom_border gt_right" rowspan="1" colspan="1" scope="col" id="<em>M (SD)</em>"><em>M (SD)</em></th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="1">1</th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="2">2</th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="3">3</th>
</tr>
50.61 (18.51)
2.26 (0.92)
.28 [0.25, 0.30]
1.67 (0.48)
.03 [0.00, 0.05]
.42 [0.40, 0.44]
4.97 (1.11)
.17 [0.15, 0.19]
-.09 [-0.11, -0.07]
-.13 [-0.15, -0.10]
ess_health %>% cor_matrix(var_names = var_renames) %>% report_cor_table(add_distributions = TRUE, data = ess_health)
<tr class="gt_col_headings">
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="Variable">Variable</th>
<th class="gt_col_heading gt_columns_bottom_border gt_right" rowspan="1" colspan="1" scope="col" id="<em>M (SD)</em>"><em>M (SD)</em></th>
<th class="gt_col_heading gt_columns_bottom_border gt_right" rowspan="1" colspan="1" scope="col" id="Distributions">Distributions</th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="1">1</th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="2">2</th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="3">3</th>
</tr>
50.61 (18.51)
2.26 (0.92)
.28 [0.25, 0.30]
1.67 (0.48)
.03 [0.00, 0.05]
.42 [0.40, 0.44]
4.97 (1.11)
.17 [0.15, 0.19]
-.09 [-0.11, -0.07]
-.13 [-0.15, -0.10]
Often, we are also interested in how the means of an outcome variable differ between different groups. It can be fiddly to get these tables and the pairwise significance tests done, but this function does it in a breeze.
# Start with this in the console - that gets you 80% of the tribbles below.
# get_rename_tribbles(ess_health, gndr, cntry)
var_renames <- tribble(
~old, ~new,
"gndr", "Gender",
"cntry", "Country"
)
level_renames <- tribble(
~var, ~level_old, ~level_new,
"gndr", "1", "male",
"gndr", "2", "female",
"cntry", "DE", "Germany",
"cntry", "FR", "France",
"cntry", "GB", "UK"
)
report_cat_vars(ess_health, health, gndr, cntry, var_names = var_renames,
level_names = level_renames)
body{background-color:white;}
male
3482
2.23 (0.90) a
female
3744
2.30 (0.93) b
Germany
3045
2.34 (0.88) a
France
1917
2.29 (0.89) a
UK
2264
2.14 (0.97) b
In psychology, it is often expected that regression models are reported with both unstandardised (B) and standardized (beta) coefficients. This can be fiddly as separate tables will contain too much redundant information. The functions below easily run a model with standardised variables and create a publication-ready table.
ess_health$gndr <- factor(ess_health$gndr)
#Standard lm model
mod1 <- lm(depression ~ agea + gndr + health + cntry, ess_health)
#Model with standardised coefficients
mod2 <- lm_std(depression ~ agea + gndr + health + cntry, ess_health)
report_lm_with_std(mod1, mod2)
body{background-color:white;}
(Intercept)
1.20 (0.02)\*\*\*
-0.14 \[-0.18, -0.10\]
agea
-0.00 (0.00)\*\*\*
-0.10 \[-0.12, -0.08\]
gndr2
0.12 (0.01)\*\*\*
0.24 \[0.20, 0.28\]
health
0.23 (0.01)\*\*\*
0.44 \[0.42, 0.47\]
cntryFR
-0.01 (0.01)
-0.02 \[-0.08, 0.03\]
cntryGB
0.04 (0.01)\*\*
0.08 \[0.03, 0.13\]
F(5, 7165) = 358.25, p \< .001
Given that dummy variables lose their interpretability when standardized (Fox, 2015), β for dummy variables are semi-standardized, indicating the impact of that dummy on the standardized outcome variable. † p \< .1, \* p \< .05, \*\* p \< .01, \*\*\* p \< .001
#Often the coefficients should be renamed - get_coef_rename_tribble(mod1)
#is the starting point. In that, markdown formatting can be used.
coef_names <- tribble(
~old, ~new,
"(Intercept)", "*(Intercept)*",
"agea", "Age",
"gndr2", "Gender *(female)*",
"health", "Poor health",
"cntryFR", "France *(vs DE)*",
"cntryGB", "UK *(vs DE)*"
)
report_lm_with_std(mod1, mod2, coef_renames = coef_names)
body{background-color:white;}
(Intercept)
1.20 (0.02)\*\*\*
-0.14 \[-0.18, -0.10\]
Age
-0.00 (0.00)\*\*\*
-0.10 \[-0.12, -0.08\]
Gender (female)
0.12 (0.01)\*\*\*
0.24 \[0.20, 0.28\]
Poor health
0.23 (0.01)\*\*\*
0.44 \[0.42, 0.47\]
France (vs DE)
-0.01 (0.01)
-0.02 \[-0.08, 0.03\]
UK (vs DE)
0.04 (0.01)\*\*
0.08 \[0.03, 0.13\]
F(5, 7165) = 358.25, p \< .001
Given that dummy variables lose their interpretability when standardized (Fox, 2015), β for dummy variables are semi-standardized, indicating the impact of that dummy on the standardized outcome variable. † p \< .1, \* p \< .05, \*\* p \< .01, \*\*\* p \< .001
#You can also easily display multiple nested models side-by-side and get the
#F-change significance test. For that, all models need to be fit on the same
#dataset, so that I will drop all missing data.
mod1 <- lm(depression ~ agea + gndr + health + cntry, tidyr::drop_na(ess_health))
mod2 <- lm_std(depression ~ agea + gndr + health + cntry, tidyr::drop_na(ess_health))
mod3 <- lm(depression ~ agea * gndr + eisced + health + cntry, tidyr::drop_na(ess_health))
mod4 <- lm_std(depression ~ agea * gndr + eisced + health + cntry, tidyr::drop_na(ess_health))
coef_names <- tribble(
~old, ~new,
"(Intercept)", "*(Intercept)*",
"agea", "Age",
"gndr2", "Gender *(female)*",
"health", "Poor health",
"cntryFR", "France *(vs DE)*",
"cntryGB", "UK *(vs DE)*",
"eisced", "Education",
"agea:gndr2", "Age x Female",
)
report_lm_with_std(mod = list(mod1, mod3), mod_std = list(mod2, mod4),
coef_renames = coef_names, R2_change = TRUE)
#> Warning: Automatic coercion from double to character was deprecated in purrr 1.0.0.
#> ℹ Please use an explicit call to `as.character()` within `map_chr()` instead.
#> ℹ The deprecated feature was likely used in the timesaveR package.
#> Please report the issue at
#> <https://github.com/LukasWallrich/timesaveR/issues>.
#> This warning is displayed once every 8 hours.
#> Call `lifecycle::last_lifecycle_warnings()` to see where this warning was
#> generated.
body{background-color:white;}
(Intercept)
1.21 (0.02)\*\*\*
-0.14 \[-0.18, -0.10\]
1.27 (0.02)\*\*\*
-0.14 \[-0.18, -0.10\]
Age
-0.00 (0.00)\*\*\*
-0.10 \[-0.12, -0.08\]
-0.00 (0.00)\*\*\*
-0.14 \[-0.17, -0.10\]
Gender (female)
0.11 (0.01)\*\*\*
0.24 \[0.20, 0.28\]
0.03 (0.03)
0.24 \[0.20, 0.28\]
Poor health
0.23 (0.01)\*\*\*
0.44 \[0.42, 0.46\]
0.23 (0.01)\*\*\*
0.44 \[0.42, 0.46\]
France (vs DE)
-0.01 (0.01)
-0.03 \[-0.08, 0.02\]
-0.01 (0.01)
-0.03 \[-0.08, 0.02\]
UK (vs DE)
0.04 (0.01)\*\*
0.08 \[0.03, 0.13\]
0.04 (0.01)\*\*
0.08 \[0.03, 0.13\]
Education
-0.00 (0.00)†
-0.02 \[-0.04, 0.00\]
Age x Female
0.00 (0.00)\*\*
0.07 \[0.02, 0.11\]
F(5, 6846) = 337.06, p \< .001
F(7, 6844) = 243.10, p \< .001
Change ΔR2 = .00, F(2, 6844) = 6.78, p = .001 Given that dummy variables lose their interpretability when standardized (Fox, 2015), β for dummy variables are semi-standardized, indicating the impact of that dummy on the standardized outcome variable. † p \< .1, \* p \< .05, \*\* p \< .01, \*\*\* p \< .001modelsummary
allows you to create highly customisable tables with data summaries or
the output of statistical models that can be saved in a wide range of
formats.apa
mostly
offers functions that turn the output of statistical tests (e.g.,
t-tests) into text, in line with APA guidelines.papaja
offers the opportunity to
create full APA-style journal manuscripts in R. It’s apa_table
function is a generic alternative to the table functions in this
package, which support many more types of models, but includes fewer
details.Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.