Codebook example with SPSS dataset
Ruben Arslan
2021-04-20
Source:vignettes/codebook_sav.Rmd
codebook_sav.Rmd
knit_by_pkgdown <- !is.null(knitr::opts_chunk$get("fig.retina"))
ggplot2::theme_set(ggplot2::theme_bw())
knitr::opts_chunk$set(warning = TRUE, message = TRUE, error = FALSE, echo = TRUE)
library(dplyr)
library(codebook)In this vignette, you can see how to use the metadata that is often already stored in SPSS and Stata files. It’s easy. All we need is the rio::import function. For files with the right file extension, we can automatically pick the right way to import the data. Here, we’re downloading straight from the Open Science Framework, so we have to specify the file extension.
We select a subset of variables, just to keep it short. The data were shared by Emanuel Jauk in a project called How alluring are dark personalities? The Dark Triad and attractiveness in speed dating.
Often, files imported from SPSS or Stata to R will not have their missings coded properly. Here, that is not the case, but if you find yourself with such a dataset, the detect_missing function makes it easy to recognise common ways to specify missing data (e.g. negative values, labelled values, 99/999).
darktriad <- rio::import("https://osf.io/j4fcb/download", format = "sav")
if (!knit_by_pkgdown) {
darktriad <- darktriad %>%
select(DG, sex, relStat, education, NPI_avg)
}
metadata(darktriad)$name <- "How alluring are dark personalities? The Dark Triad and attractiveness in speed dating"
metadata(darktriad)$description <- paste0([1784 chars quoted with '"'])
metadata(darktriad)$identifier <- "https://osf.io/jvk3u/"
metadata(darktriad)$datePublished <- "2015-10-07"
metadata(darktriad)$creator <- list(
"@type" = "Person",
givenName = "Emanuel", familyName = "Jauk",
email = "emanuel.jauk@uni‐graz.at",
affiliation = list("@type" = "Organization",
name = "Karl‐Franzens‐Universität Graz, Austria"))
metadata(darktriad)$citation <- "Jauk, E., Neubauer, A. C., Mairunteregger, T., Pemp, S., Sieber, K. P., & Rauthmann, J. F. (2016). How alluring are dark personalities? The Dark Triad and attractiveness in speed dating. European Journal of Personality, 30(2), 125-138."
metadata(darktriad)$url <- "https://osf.io/j4fcb/"
metadata(darktriad)$temporalCoverage <- "2015"
metadata(darktriad)$spatialCoverage <- "Graz, Austria"
metadata(darktriad)$distribution = list(
list("@type" = "DataDownload",
"requiresSubscription" = "http://schema.org/True",
"encodingFormat" = "https://www.loc.gov/preservation/digital/formats/fdd/fdd000469.shtml",
contentUrl = "https://osf.io/j4fcb/download")
)
# We don't want to look at the code in the codebook.
knitr::opts_chunk$set(warning = TRUE, message = TRUE, echo = FALSE)Now, we can immediately generate a codebook.
Metadata
Description
Dataset name: How alluring are dark personalities? The Dark Triad and attractiveness in speed dating
The data to this speed dating study comes in two different formats: Personwise (one record for each individual) and dyadic (pairwise; one record for each date). The respective SPSS files are named “DarkTriadDate_person.sav” and “DarkTriadDate_dyad.sav”.
Personwise datafile
The personwise datafile contains individual differences variables and perceiver and target effects according to the social relations model. These are centered marginal means that were calculated according to the formulae provided by Kenny, Kashy, and Cook (2006). These effects are not (!) based on multilevel analyses.
Preprocessing
All rating variables (i.e., actual choice, friendship, short-term relationship etc.) were corrected for prior acquaintance, which means that dates wih prior acquaintance were excluded (set to missing) on a dyadic basis.
Variables are labeled in SPSS.
A list of important abbreviations, prefixes and suffixes:
- _acq = acquaintance (i.e., variables with this suffix are controlled for prior * acquaintance)
- avg = average
- _rat = rating variable
- _z = z-standardized score
- BC = booty call
- DG = dating group (three groups in this study)
- FIPI = five item personality inventory
- FS = friendship
- FWB = friends-with-benefits
- Int = Intelligence
- Like = Likeability
- LTR = long-term relationship
- MACHIV = mach-iv machiavellianism questionnaire
- N, E, O, A, C = Big5
- NPI = narcissistic personality inventory
- ONS = one night stand
- P = perceiver
- PA = physical attractiveness
- PercEff = perceiver effect
- SD = speed dating
- SRM = social relations model
- SRP = self-report psychopathy scale
- STR = short-term relationship
- T = target
- TargEff = target effect
Metadata for search engines
Temporal Coverage: 2015
Spatial Coverage: Graz, Austria
Citation: Jauk, E., Neubauer, A. C., Mairunteregger, T., Pemp, S., Sieber, K. P., & Rauthmann, J. F. (2016). How alluring are dark personalities? The Dark Triad and attractiveness in speed dating. European Journal of Personality, 30(2), 125-138.
Identifier: https://osf.io/jvk3u/
Date published: 2015-10-07
Creator:
| name | value |
|---|---|
| @type | Person |
| givenName | Emanuel |
| familyName | Jauk |
| emanuel.jauk@uni‐graz.at | |
| affiliation | Organization , Karl‐Franzens‐Universität Graz, Austria |
|
|
Variables
sex
sex
relStat
relationship status
education
highest educational attainment
contracept
hormonal contraception
date
past experience with speed dating
TargEff__choice_relFrequ_acq {#TargEff__choice_relFrequ_acq .tabset}
SRM target effect: actual choice
TargEff__STR_avg_acq {#TargEff__STR_avg_acq .tabset}
SRM target effect: short-term relationship (aggregated)
PercEff__choice_relFrequ_acq {#PercEff__choice_relFrequ_acq .tabset}
SRM perceiver effect: actual choice
PercEff__STR_avg_acq {#PercEff__STR_avg_acq .tabset}
SRM perceiver effect: short-term relationship (aggregated)
Codebook table
JSON-LD metadata
The following JSON-LD can be found by search engines, if you share this codebook publicly on the web.
{
"name": "How alluring are dark personalities? The Dark Triad and attractiveness in speed dating",
"description": "The data to this speed dating study comes in two different formats: Personwise (one record for each individual) and dyadic (pairwise; one record for each date). The respective SPSS files are named \"DarkTriadDate_person.sav\" and \"DarkTriadDate_dyad.sav\".\n\n### Download link\n[Open Science Framework](https://osf.io/j4fcb/download)\n\n### Personwise datafile \nThe personwise datafile contains individual differences variables and perceiver and target effects according to the social relations model. These are centered marginal means that were calculated according to the formulae provided by Kenny, Kashy, and Cook (2006). These effects are not (!) based on multilevel analyses.\n\n### Preprocessing\nAll rating variables (i.e., actual choice, friendship, short-term relationship etc.) were corrected for prior acquaintance, which means that dates wih prior acquaintance were excluded (set to missing) on a dyadic basis.\n\nVariables are labeled in SPSS. \n\n### A list of important abbreviations, prefixes and suffixes:\n\n* _acq = acquaintance (i.e., variables with this suffix are controlled for prior * acquaintance)\n* avg = average\n* _rat = rating variable\n* _z = z-standardized score\n* BC = booty call\n* DG = dating group (three groups in this study)\n* FIPI = five item personality inventory\n* FS = friendship\n* FWB = friends-with-benefits\n* Int = Intelligence\n* Like = Likeability\n* LTR = long-term relationship\n* MACHIV = mach-iv machiavellianism questionnaire\n* N, E, O, A, C = Big5\n* NPI = narcissistic personality inventory\n* ONS = one night stand\n* P = perceiver\n* PA = physical attractiveness\n* PercEff = perceiver effect\n* SD = speed dating\n* SRM = social relations model\n* SRP = self-report psychopathy scale\n* STR = short-term relationship\n* T = target\n* TargEff = target effect\n\n\n\n\n\n## Table of variables\nThis table contains variable names, labels, and number of missing values.\nSee the complete codebook for more.\n\n[truncated]\n\n### Note\nThis dataset was automatically described using the [codebook R package](https://rubenarslan.github.io/codebook/) (version 0.9.4.9000).",
"identifier": "https://osf.io/jvk3u/",
"datePublished": "2015-10-07",
"creator": {
"@type": "Person",
"givenName": "Emanuel",
"familyName": "Jauk",
"email": "emanuel.jauk@uni‐graz.at",
"affiliation": {
"@type": "Organization",
"name": "Karl‐Franzens‐Universität Graz, Austria"
}
},
"citation": "Jauk, E., Neubauer, A. C., Mairunteregger, T., Pemp, S., Sieber, K. P., & Rauthmann, J. F. (2016). How alluring are dark personalities? The Dark Triad and attractiveness in speed dating. European Journal of Personality, 30(2), 125-138.",
"url": "https://osf.io/j4fcb/",
"temporalCoverage": "2015",
"spatialCoverage": "Graz, Austria",
"distribution": [
{
"@type": "DataDownload",
"requiresSubscription": "http://schema.org/True",
"encodingFormat": "https://www.loc.gov/preservation/digital/formats/fdd/fdd000469.shtml",
"contentUrl": "https://osf.io/j4fcb/download"
}
],
"keywords": ["SD_Code", "DG", "DG_size", "DG_size_acq", "age", "sex", "height", "weight", "relStat", "relStat_other", "education", "contracept", "date", "NPI_avg", "SRP_avg", "MACHIV_avg", "BFI_N_avg", "BFI_E_avg", "BFI_O_avg", "BFI_A_avg", "BFI_C_avg", "PA_R1", "PA_R2", "PA_R3", "PA_R4", "PA_avg", "BMI", "SOI_R_B_avg", "SOI_R_A_avg", "SOI_R_D_avg", "TargEff__choice_relFrequ_acq", "TargEff__FS_avg_acq", "TargEff__ONS_avg_acq", "TargEff__BC_avg_acq", "TargEff__FWB_avg_acq", "TargEff__STR_avg_acq", "TargEff__LTR_avg_acq", "TargEff__PA_avg_acq", "TargEff__Like_avg_acq", "TargEff__Int_avg_acq", "TargEff__FIPI_N_avg_acq", "TargEff__FIPI_E_avg_acq", "TargEff__FIPI_O_avg_acq", "TargEff__FIPI_A_avg_acq", "TargEff__FIPI_C_avg_acq", "PercEff__choice_relFrequ_acq", "PercEff__FS_avg_acq", "PercEff__ONS_avg_acq", "PercEff__BC_avg_acq", "PercEff__FWB_avg_acq", "PercEff__STR_avg_acq", "PercEff__LTR_avg_acq", "PercEff__PA_avg_acq", "PercEff__Like_avg_acq", "PercEff__Int_avg_acq", "PercEff__FIPI_N_avg_acq", "PercEff__FIPI_E_avg_acq", "PercEff__FIPI_O_avg_acq", "PercEff__FIPI_A_avg_acq", "PercEff__FIPI_C_avg_acq"],
"@context": "http://schema.org/",
"@type": "Dataset",
"variableMeasured": [
{
"name": "SD_Code",
"description": "speed dating code",
"@type": "propertyValue"
},
{
"name": "DG",
"description": "dating group",
"@type": "propertyValue"
},
{
"name": "DG_size",
"description": "dating group size",
"@type": "propertyValue"
},
{
"name": "DG_size_acq",
"description": "dating group size, corrected for prior acquaintance",
"@type": "propertyValue"
},
{
"name": "age",
"description": "age",
"@type": "propertyValue"
},
{
"name": "sex",
"description": "sex",
"value": "1. female,\n2. male",
"maxValue": 2,
"minValue": 1,
"@type": "propertyValue"
},
{
"name": "height",
"description": "height",
"@type": "propertyValue"
},
{
"name": "weight",
"description": "weight",
"@type": "propertyValue"
},
{
"name": "relStat",
"description": "relationship status",
"value": "1. single,\n2. in a relationship,\n3. living separately / divorced",
"maxValue": 3,
"minValue": 1,
"@type": "propertyValue"
},
{
"name": "relStat_other",
"description": "other relationship status",
"@type": "propertyValue"
},
{
"name": "education",
"description": "highest educational attainment",
"value": "1. nine years schooling only,\n2. professional training,\n3. vocational school,\n4. university-entrance diploma,\n5. academic degree",
"maxValue": 5,
"minValue": 1,
"@type": "propertyValue"
},
{
"name": "contracept",
"description": "hormonal contraception",
"value": "1. yes,\n2. no",
"maxValue": 2,
"minValue": 1,
"@type": "propertyValue"
},
{
"name": "date",
"description": "past experience with speed dating",
"value": "1. yes,\n2. no",
"maxValue": 2,
"minValue": 1,
"@type": "propertyValue"
},
{
"name": "NPI_avg",
"description": "narcissistic personality inventory - average",
"@type": "propertyValue"
},
{
"name": "SRP_avg",
"description": "self-report psychopathy scale - average",
"@type": "propertyValue"
},
{
"name": "MACHIV_avg",
"description": "mach-iv - average",
"@type": "propertyValue"
},
{
"name": "BFI_N_avg",
"description": "big five inventory: neuroticism - average",
"@type": "propertyValue"
},
{
"name": "BFI_E_avg",
"description": "big five inventory: extraversion - average",
"@type": "propertyValue"
},
{
"name": "BFI_O_avg",
"description": "big five inventory: openness - average",
"@type": "propertyValue"
},
{
"name": "BFI_A_avg",
"description": "big five inventory: agreeableness - average",
"@type": "propertyValue"
},
{
"name": "BFI_C_avg",
"description": "big five inventory: conscientiousness - average",
"@type": "propertyValue"
},
{
"name": "PA_R1",
"description": "physical attractiveness - rater1(f)",
"@type": "propertyValue"
},
{
"name": "PA_R2",
"description": "physical attractiveness - rater2(f)",
"@type": "propertyValue"
},
{
"name": "PA_R3",
"description": "physical attractiveness - rater3(m)",
"@type": "propertyValue"
},
{
"name": "PA_R4",
"description": "physical attractiveness - rater4(m)",
"@type": "propertyValue"
},
{
"name": "PA_avg",
"description": "physical attractiveness - average",
"@type": "propertyValue"
},
{
"name": "BMI",
"description": "body mass index",
"@type": "propertyValue"
},
{
"name": "SOI_R_B_avg",
"description": "sociosexual orientation inventory revised: behavior - average",
"@type": "propertyValue"
},
{
"name": "SOI_R_A_avg",
"description": "sociosexual orientation inventory revised: attitude - average",
"@type": "propertyValue"
},
{
"name": "SOI_R_D_avg",
"description": "sociosexual orientation inventory revised: desire - average",
"@type": "propertyValue"
},
{
"name": "TargEff__choice_relFrequ_acq",
"description": "SRM target effect: actual choice",
"@type": "propertyValue"
},
{
"name": "TargEff__FS_avg_acq",
"description": "SRM target effect: friendship",
"@type": "propertyValue"
},
{
"name": "TargEff__ONS_avg_acq",
"description": "SRM target effect: one night stand",
"@type": "propertyValue"
},
{
"name": "TargEff__BC_avg_acq",
"description": "SRM target effect: booty call",
"@type": "propertyValue"
},
{
"name": "TargEff__FWB_avg_acq",
"description": "SRM target effect: friends-with-benefits",
"@type": "propertyValue"
},
{
"name": "TargEff__STR_avg_acq",
"description": "SRM target effect: short-term relationship (aggregated)",
"@type": "propertyValue"
},
{
"name": "TargEff__LTR_avg_acq",
"description": "SRM target effect: long-term relationship",
"@type": "propertyValue"
},
{
"name": "TargEff__PA_avg_acq",
"description": "SRM target effect: physical attractiveness",
"@type": "propertyValue"
},
{
"name": "TargEff__Like_avg_acq",
"description": "SRM target effect: likeability",
"@type": "propertyValue"
},
{
"name": "TargEff__Int_avg_acq",
"description": "SRM target effect: intelligence",
"@type": "propertyValue"
},
{
"name": "TargEff__FIPI_N_avg_acq",
"description": "SRM target effect: neuroticism",
"@type": "propertyValue"
},
{
"name": "TargEff__FIPI_E_avg_acq",
"description": "SRM target effect: extraversion",
"@type": "propertyValue"
},
{
"name": "TargEff__FIPI_O_avg_acq",
"description": "SRM target effect: openness",
"@type": "propertyValue"
},
{
"name": "TargEff__FIPI_A_avg_acq",
"description": "SRM target effect: agreeableness",
"@type": "propertyValue"
},
{
"name": "TargEff__FIPI_C_avg_acq",
"description": "SRM target effect: conscientiousness",
"@type": "propertyValue"
},
{
"name": "PercEff__choice_relFrequ_acq",
"description": "SRM perceiver effect: actual choice",
"@type": "propertyValue"
},
{
"name": "PercEff__FS_avg_acq",
"description": "SRM perceiver effect: friendship",
"@type": "propertyValue"
},
{
"name": "PercEff__ONS_avg_acq",
"description": "SRM perceiver effect: one night stand",
"@type": "propertyValue"
},
{
"name": "PercEff__BC_avg_acq",
"description": "SRM perceiver effect: booty call",
"@type": "propertyValue"
},
{
"name": "PercEff__FWB_avg_acq",
"description": "SRM perceiver effect: friends-with-benefits",
"@type": "propertyValue"
},
{
"name": "PercEff__STR_avg_acq",
"description": "SRM perceiver effect: short-term relationship (aggregated)",
"@type": "propertyValue"
},
{
"name": "PercEff__LTR_avg_acq",
"description": "SRM perceiver effect: long-term relationship",
"@type": "propertyValue"
},
{
"name": "PercEff__PA_avg_acq",
"description": "SRM perceiver effect: physical attractiveness",
"@type": "propertyValue"
},
{
"name": "PercEff__Like_avg_acq",
"description": "SRM perceiver effect: likeability",
"@type": "propertyValue"
},
{
"name": "PercEff__Int_avg_acq",
"description": "SRM perceiver effect: intelligence",
"@type": "propertyValue"
},
{
"name": "PercEff__FIPI_N_avg_acq",
"description": "SRM perceiver effect: neuroticism",
"@type": "propertyValue"
},
{
"name": "PercEff__FIPI_E_avg_acq",
"description": "SRM perceiver effect: extraversion",
"@type": "propertyValue"
},
{
"name": "PercEff__FIPI_O_avg_acq",
"description": "SRM perceiver effect: openness",
"@type": "propertyValue"
},
{
"name": "PercEff__FIPI_A_avg_acq",
"description": "SRM perceiver effect: agreeableness",
"@type": "propertyValue"
},
{
"name": "PercEff__FIPI_C_avg_acq",
"description": "SRM perceiver effect: conscientiousness",
"@type": "propertyValue"
}
]
}`