Package: codebook 0.9.5

codebook: Automatic Codebooks from Metadata Encoded in Dataset Attributes

Easily automate the following tasks to describe data frames: Summarise the distributions, and labelled missings of variables graphically and using descriptive statistics. For surveys, compute and summarise reliabilities (internal consistencies, retest, multilevel) for psychological scales. Combine this information with metadata (such as item labels and labelled values) that is derived from R attributes. To do so, the package relies on 'rmarkdown' partials, so you can generate HTML, PDF, and Word documents. Codebooks are also available as tables (CSV, Excel, etc.) and in JSON-LD, so that search engines can find your data and index the metadata. The metadata are also available at your fingertips via RStudio Addins.

Authors:Ruben Arslan [aut, cre]

codebook_0.9.5.tar.gz
codebook_0.9.5.zip(r-4.5)codebook_0.9.5.zip(r-4.4)codebook_0.9.5.zip(r-4.3)
codebook_0.9.5.tgz(r-4.4-any)codebook_0.9.5.tgz(r-4.3-any)
codebook_0.9.5.tar.gz(r-4.5-noble)codebook_0.9.5.tar.gz(r-4.4-noble)
codebook_0.9.5.tgz(r-4.4-emscripten)codebook_0.9.5.tgz(r-4.3-emscripten)
codebook.pdf |codebook.html✨
codebook/json (API)
NEWS

# Install 'codebook' in R:
install.packages('codebook', repos = c('https://rubenarslan.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/rubenarslan/codebook/issues

Datasets:
  • bfi - Mock BFI data

On CRAN:

codebookdocumentationformrjson-ldmetadataspsswebapp

8.04 score 141 stars 195 scripts 1.0k downloads 51 exports 76 dependencies

Last updated 1 months agofrom:b24d189a5c. Checks:OK: 3 NOTE: 4. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 14 2024
R-4.5-winOKNov 14 2024
R-4.5-linuxOKNov 14 2024
R-4.4-winNOTENov 14 2024
R-4.4-macNOTENov 14 2024
R-4.3-winNOTENov 14 2024
R-4.3-macNOTENov 14 2024

Exports:%>%add_Raggregate_and_document_scaleas_factorcodebookcodebook_browsercodebook_component_scalecodebook_component_single_itemcodebook_data_infocodebook_itemscodebook_missingnesscodebook_survey_overviewcodebook_tablecompact_codebookcompute_reliabilitiesdata_description_defaultdetect_missingdetect_missingsdetect_scalesdict_to_listendedexpiredhas_labelhas_labelsknit_print.alphalabel_browserlabel_browser_staticlikert_from_itemslist_to_dictload_data_and_render_codebookmd_patternmetadatametadata_jsonldmetadata_listmetadata<-modifiednew_codebook_rmdplot_labelledrescue_attributesreverse_labelled_valuesskim_codebookto_factorval_labelval_label<-val_labelsval_labels<-var_labelvar_label<-zap_attributeszap_labelzap_labelled

Dependencies:base64encbitbit64clicliprcodetoolscolorspacecpp11crayondigestdplyrevaluatefansifarverfastmapforcatsfuturegenericsggplot2globalsglueGPArotationgridExtragtablehavenhighrhmshtmltoolsisobandjsonliteknitrlabelinglabelledlatticelifecyclelikertlistenvmagrittrMASSMatrixmgcvmnormtmunsellnlmeparallellypillarpkgconfigplyrprettyunitsprogresspsychpurrrR6RColorBrewerRcppreadrreprreshape2rlangrmdpartialsscalesskimrstringistringrtibbletidyrtidyselecttzdbutf8vctrsviridisLitevroomwithrxfunxtableyaml

Codebook example with Qualtrics dataset

Ruben Arslan

Rendered fromcodebook_qualtrics.Rmdusingknitr::rmarkdownon Nov 14 2024.

Last update: 2020-06-05
Started: 2018-08-01

Codebook example with SPSS dataset

Ruben Arslan

Rendered fromcodebook_sav.Rmdusingknitr::rmarkdownon Nov 14 2024.

Last update: 2024-10-14
Started: 2018-08-01

Tutorial

Ruben Arslan

Rendered fromcodebook_tutorial.Rmdusingknitr::rmarkdownon Nov 14 2024.

Last update: 2024-10-14
Started: 2018-10-23

Codebook example with formr.org data

Ruben Arslan

Rendered fromcodebook.Rmdusingknitr::rmarkdownon Nov 14 2024.

Last update: 2024-10-14
Started: 2018-03-15

Readme and manuals

Help Manual

Help pageTopics
Append R to string, if it doesn't end in R already.add_R
Aggregate variables and remember which variables this wereaggregate_and_document_scale
Mock BFI databfi
Generate rmarkdown codebookcodebook
Browse and search codebookcodebook_browser
Codebook component for scalescodebook_component_scale
Codebook component for single itemscodebook_component_single_item
Codebook data infocodebook_data_info
Tabular codebookcodebook_items
Codebook missingnesscodebook_missingness
Codebook survey overviewcodebook_survey_overview
Codebook metadata tablecodebook_table
Compact Codebookcompact_codebook
Compute reliabilitiescompute_reliabilities
Data description defaultdata_description_default
Detect missing valuesdetect_missing detect_missings
Detect item scalesdetect_scales
How many surveys were ended?ended
How many surveys were expired?expired
Define skimmers for haven_labelled variablesget_skimmers.haven_labelled
Define skimmers for haven_labelled_spss variablesget_skimmers.haven_labelled_spss
Has labelhas_label
Has labelshas_labels
Pretty-print a Cronbach's alpha objectknit_print.alpha
Print a 'stats::cor.test()' object for knitrknit_print.htest
Print a 'psych::multilevel.reliability()' object for knitrknit_print.multilevel
Browse and search variable and value labelslabel_browser
Browse and search variable and value labelslabel_browser_static
Derive a likert object from itemslikert_from_items
Go from a named list to a key-value data frame or data dictionary and backdict_to_list list_to_dict
Submit a data file and an rmarkdown template as a file to generate a codebook. Used chiefly in the webapp.load_data_and_render_codebook
Missing data patternsmd_pattern
Add metadata to a datasetmetadata metadata<-
Metadata as JSON-LDmetadata_jsonld
Metadata from dataframemetadata_list
How many surveys were modified?modified
Create a codebook rmarkdown documentnew_codebook_rmd
Plot labelled vectorplot_labelled
Rescue lost attributesrescue_attributes
Reverse labelled values reverse the underlying values for a numeric 'haven::labelled()' vector while keeping the labels correctreverse_labelled_values
Skim codebookskim_codebook
To factorto_factor
Zap attributeszap_attributes
Zap labelled classzap_labelled