{ "_id": "6a1bea211d7bb097a0a1e0cf", "Package": "codebook", "Title": "Automatic Codebooks from Metadata Encoded in Dataset Attributes", "Description": "Easily automate the following tasks to describe data\nframes: Summarise the distributions, and labelled missings of\nvariables graphically and using descriptive statistics. For\nsurveys, compute and summarise reliabilities (internal\nconsistencies, retest, multilevel) for psychological scales.\nCombine this information with metadata (such as item labels and\nlabelled values) that is derived from R attributes. To do so,\nthe package relies on 'rmarkdown' partials, so you can generate\nHTML, PDF, and Word documents. Codebooks are also available as\ntables (CSV, Excel, etc.) and in JSON-LD, so that search\nengines can find your data and index the metadata. The metadata\nare also available at your fingertips via RStudio Addins.", "Version": "0.10.1", "Authors@R": "person(\"Ruben\", \"Arslan\", email = \"ruben.arslan@gmail.com\", role = c(\"aut\", \"cre\"))", "Language": "en-GB", "URL": "https://rubenarslan.github.io/codebook/,\nhttps://github.com/rubenarslan/codebook", "BugReports": "https://github.com/rubenarslan/codebook/issues", "License": "MIT + file LICENSE", "Encoding": "UTF-8", "LazyData": "true", "RoxygenNote": "7.3.3", "Roxygen": "list(markdown = TRUE)", "VignetteBuilder": "knitr", "Config/pak/sysreqs": "make libicu-dev libx11-dev zlib1g-dev", "Repository": "https://rubenarslan.r-universe.dev", "Date/Publication": "2026-03-02 14:05:09 UTC", "RemoteUrl": "https://github.com/rubenarslan/codebook", "RemoteRef": "HEAD", "RemoteSha": "6433edb323f50b7d1737b5b91277f1f129162eb2", "NeedsCompilation": "no", "Packaged": { "Date": "2026-05-31 07:22:31 UTC", "User": "root" }, "Author": "Ruben Arslan [aut, cre]", "Maintainer": "Ruben Arslan ", "MD5sum": "cc7125c156953b6d86af99e225cf2f9c", "_user": "rubenarslan", "_type": "src", "_file": "codebook_0.10.1.tar.gz", "_fileid": "445d1d794f5dcf8c43f228aef4be8e2d3e09c2144048efcdad1dc58d38e741ce", "_filesize": 3871520, "_sha256": "445d1d794f5dcf8c43f228aef4be8e2d3e09c2144048efcdad1dc58d38e741ce", "_created": "2026-05-31T07:22:31.000Z", "_published": "2026-05-31T07:58:25.781Z", "_distro": "noble", "_jobs": [ { "job": 78708413317, "time": 164, "config": "linux-devel-x86_64", "r": "4.7.0", "check": "OK", "artifact": "7314788586" }, { "job": 78708413314, "time": 161, "config": "linux-release-x86_64", "r": "4.6.0", "check": "OK", "artifact": "7314788278" }, { "job": 78708413307, "time": 104, "config": "macos-oldrel-arm64", "r": "4.5.3", "check": "OK", "artifact": "7315010413" }, { "job": 78708413300, "time": 92, "config": "macos-release-arm64", "r": "4.6.0", "check": "OK", "artifact": "7315017222" }, { "job": 78708155736, "time": 280, "config": "source", "r": "4.6.0", "check": "OK", "artifact": "7314768440" }, { "job": 78708413303, "time": 144, "config": "wasm-release", "r": "4.6.0", "check": "OK", "artifact": "7314786024" }, { "job": 78708413305, "time": 103, "config": "windows-devel", "r": "4.7.0", "check": "OK", "artifact": "7314780910" }, { "job": 78708413310, "time": 95, "config": "windows-oldrel", "r": "4.5.3", "check": "OK", "artifact": "7314780062" }, { "job": 78708413311, "time": 100, "config": "windows-release", "r": "4.6.0", "check": "OK", "artifact": "7314780569" } ], "_buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025", "_status": "success", "_host": "GitHub-Actions", "_upstream": "https://github.com/rubenarslan/codebook", "_commit": { "id": "6433edb323f50b7d1737b5b91277f1f129162eb2", "author": "Ruben C. Arslan ", "committer": "Ruben C. Arslan ", "message": "fix CRAN/OSF problems by inlining data\n", "time": 1772460309 }, "_maintainer": { "name": "Ruben Arslan", "email": "ruben.arslan@gmail.com", "login": "rubenarslan", "bluesky": "@ruben.the100.ci", "twitter": "@rubenarslan", "description": "Psychologist. Working on an open source survey and study software (formr.org), two R packages and reproducible documentation of my statistical analyses.", "uuid": 831109 }, "_registered": true, "_dependencies": [ { "package": "R", "version": ">= 3.5.0", "role": "Depends" }, { "package": "stats", "role": "Imports" }, { "package": "methods", "role": "Imports" }, { "package": "graphics", "role": "Imports" }, { "package": "utils", "role": "Imports" }, { "package": "rmdpartials", "role": "Imports" }, { "package": "forcats", "version": ">= 0.4.0", "role": "Imports" }, { "package": "vctrs", "version": ">= 0.3.0", "role": "Imports" }, { "package": "ggplot2", "version": ">= 2.0.0", "role": "Imports" }, { "package": "stringr", "role": "Imports" }, { "package": "rlang", "role": "Imports" }, { "package": "dplyr", "version": ">= 1.0.0", "role": "Imports" }, { "package": "tidyr", "role": "Imports" }, { "package": "jsonlite", "role": "Imports" }, { "package": "haven", "version": ">= 2.3.0", "role": "Imports" }, { "package": "purrr", "role": "Imports" }, { "package": "tibble", "role": "Imports" }, { "package": "glue", "role": "Imports" }, { "package": "likert", "role": "Imports" }, { "package": "knitr", "role": "Imports" }, { "package": "skimr", "version": ">= 2.1.0", "role": "Imports" }, { "package": "htmltools", "role": "Imports" }, { "package": "labeling", "role": "Imports" }, { "package": "labelled", "role": "Imports" }, { "package": "future", "role": "Imports" }, { "package": "testthat", "role": "Suggests" }, { "package": "DT", "version": ">= 0.33", "role": "Suggests" }, { "package": "lme4", "role": "Suggests" }, { "package": "rmarkdown", "role": "Suggests" }, { "package": "rstudioapi", "version": ">= 0.5", "role": "Suggests" }, { "package": "shiny", "version": ">= 1.8.1", "role": "Suggests" }, { "package": "miniUI", "version": ">= 0.1.1", "role": "Suggests" }, { "package": "roxygen2", "role": "Suggests" }, { "package": "rio", "role": "Suggests" }, { "package": "psych", "role": "Suggests" } ], "_owner": "rubenarslan", "_selfowned": true, "_usedby": 0, "_updates": [ { "week": "2026-08", "n": 1 }, { "week": "2026-09", "n": 11 }, { "week": "2026-10", "n": 2 } ], "_tags": [ { "name": "v0.10.0", "date": "2026-02-26" } ], "_topics": [ "codebook", "documentation", "formr", "json-ld", "metadata", "spss", "webapp" ], "_stars": 150, "_contributors": [ { "user": "rubenarslan", "count": 275, "uuid": 831109 }, { "user": "hadley", "count": 2, "uuid": 4196 } ], "_userbio": { "uuid": 831109, "type": "user", "name": "Ruben C. Arslan", "description": "Psychologist. Working on an open source survey and study software (formr.org), two R packages and reproducible documentation of my statistical analyses." }, "_downloads": { "count": 678, "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/codebook" }, "_devurl": "https://github.com/rubenarslan/codebook", "_pkgdown": "https://rubenarslan.github.io/codebook/", "_searchresults": 278, "_rbuild": "4.6.0", "_assets": [ "extra/citation.cff", "extra/citation.html", "extra/citation.json", "extra/citation.txt", "extra/codebook.html", "extra/contents.json", "extra/NEWS.html", "extra/NEWS.txt", "extra/readme.html", "extra/readme.md", "manual.pdf" ], "_homeurl": "https://github.com/rubenarslan/codebook", "_realowner": "rubenarslan", "_cranurl": true, "_releases": [ { "version": "0.5.8", "date": "2018-03-21" }, { "version": "0.5.9", "date": "2018-05-22" }, { "version": "0.6.2", "date": "2018-07-26" }, { "version": "0.6.3", "date": "2018-08-01" }, { "version": "0.7.4", "date": "2018-11-24" }, { "version": "0.7.5", "date": "2018-12-04" }, { "version": "0.7.6", "date": "2019-01-08" }, { "version": "0.8.0", "date": "2019-02-21" }, { "version": "0.8.1", "date": "2019-05-21" }, { "version": "0.8.2", "date": "2020-01-09" }, { "version": "0.9.2", "date": "2020-06-07" }, { "version": "0.9.5", "date": "2024-10-14" }, { "version": "0.9.6", "date": "2025-01-08" }, { "version": "0.10.0", "date": "2026-02-26" }, { "version": "0.10.1", "date": "2026-03-03" } ], "_exports": [ "%>%", "add_R", "aggregate_and_document_scale", "as_factor", "codebook", "codebook_browser", "codebook_component_scale", "codebook_component_single_item", "codebook_data_info", "codebook_items", "codebook_missingness", "codebook_survey_overview", "codebook_table", "compact_codebook", "compute_reliabilities", "data_description_default", "detect_missing", "detect_missings", "detect_scales", "dict_to_list", "ended", "expired", "has_label", "has_labels", "knit_print.alpha", "label_browser", "label_browser_static", "likert_from_items", "list_to_dict", "load_data_and_render_codebook", "md_pattern", "metadata", "metadata_jsonld", "metadata_list", "metadata<-", "modified", "new_codebook_rmd", "plot_labelled", "rescue_attributes", "reverse_labelled_values", "skim_codebook", "to_factor", "val_label", "val_label<-", "val_labels", "val_labels<-", "var_label", "var_label<-", "zap_attributes", "zap_label", "zap_labelled" ], "_datasets": [ { "name": "bfi", "title": "Mock BFI data", "object": "bfi", "class": [ "data.frame" ], "fields": [ "session", "created", "modified", "ended", "expired", "BFIK_open_2", "BFIK_agree_4R", "BFIK_extra_2", "BFIK_agree_1R", "BFIK_open_1", "BFIK_neuro_2R", "BFIK_consc_3", "BFIK_consc_4", "BFIK_consc_2R", "BFIK_agree_3R", "BFIK_extra_3R", "BFIK_neuro_3", "BFIK_neuro_4", "BFIK_agree_2", "BFIK_consc_1", "BFIK_open_4", "BFIK_extra_4", "BFIK_extra_1R", "BFIK_open_3", "BFIK_agree", "BFIK_open", "BFIK_consc", "BFIK_extra", "BFIK_neuro" ], "rows": 28, "table": true, "tojson": false } ], "_help": [ { "page": "add_R", "title": "Append R to string, if it doesn't end in R already.", "topics": [ "add_R" ] }, { "page": "aggregate_and_document_scale", "title": "Aggregate variables and remember which variables this were", "topics": [ "aggregate_and_document_scale" ] }, { "page": "bfi", "title": "Mock BFI data", "topics": [ "bfi" ] }, { "page": "codebook", "title": "Generate rmarkdown codebook", "topics": [ "codebook" ] }, { "page": "codebook_browser", "title": "Browse and search codebook", "topics": [ "codebook_browser" ] }, { "page": "codebook_component_scale", "title": "Codebook component for scales", "topics": [ "codebook_component_scale" ] }, { "page": "codebook_component_single_item", "title": "Codebook component for single items", "topics": [ "codebook_component_single_item" ] }, { "page": "codebook_data_info", "title": "Codebook data info", "topics": [ "codebook_data_info" ] }, { "page": "codebook_items", "title": "Tabular codebook", "topics": [ "codebook_items" ] }, { "page": "codebook_missingness", "title": "Codebook missingness", "topics": [ "codebook_missingness" ] }, { "page": "codebook_survey_overview", "title": "Codebook survey overview", "topics": [ "codebook_survey_overview" ] }, { "page": "codebook_table", "title": "Codebook metadata table", "topics": [ "codebook_table" ] }, { "page": "compact_codebook", "title": "Compact Codebook", "topics": [ "compact_codebook" ] }, { "page": "compute_reliabilities", "title": "Compute reliabilities", "topics": [ "compute_reliabilities" ] }, { "page": "data_description_default", "title": "Data description default", "topics": [ "data_description_default" ] }, { "page": "detect_missing", "title": "Detect missing values", "topics": [ "detect_missing", "detect_missings" ] }, { "page": "detect_scales", "title": "Detect item scales", "topics": [ "detect_scales" ] }, { "page": "ended", "title": "How many surveys were ended?", "topics": [ "ended" ] }, { "page": "expired", "title": "How many surveys were expired?", "topics": [ "expired" ] }, { "page": "get_skimmers.haven_labelled", "title": "Define skimmers for haven_labelled variables", "topics": [ "get_skimmers.haven_labelled" ] }, { "page": "get_skimmers.haven_labelled_spss", "title": "Define skimmers for haven_labelled_spss variables", "topics": [ "get_skimmers.haven_labelled_spss" ] }, { "page": "has_label", "title": "Has label", "topics": [ "has_label" ] }, { "page": "has_labels", "title": "Has labels", "topics": [ "has_labels" ] }, { "page": "knit_print.alpha", "title": "Pretty-print a Cronbach's alpha object", "topics": [ "knit_print.alpha" ] }, { "page": "knit_print.htest", "title": "Print a 'stats::cor.test()' object for knitr", "topics": [ "knit_print.htest" ] }, { "page": "knit_print.multilevel", "title": "Print a 'psych::multilevel.reliability()' object for knitr", "topics": [ "knit_print.multilevel" ] }, { "page": "label_browser", "title": "Browse and search variable and value labels", "topics": [ "label_browser" ] }, { "page": "label_browser_static", "title": "Browse and search variable and value labels", "topics": [ "label_browser_static" ] }, { "page": "likert_from_items", "title": "Derive a likert object from items", "topics": [ "likert_from_items" ] }, { "page": "list_to_dict", "title": "Go from a named list to a key-value data frame or data dictionary and back", "topics": [ "dict_to_list", "list_to_dict" ] }, { "page": "load_data_and_render_codebook", "title": "Submit a data file and an rmarkdown template as a file to generate a codebook. Used chiefly in the webapp.", "topics": [ "load_data_and_render_codebook" ] }, { "page": "md_pattern", "title": "Missing data patterns", "topics": [ "md_pattern" ] }, { "page": "metadata", "title": "Add metadata to a dataset", "topics": [ "metadata", "metadata<-" ] }, { "page": "metadata_jsonld", "title": "Metadata as JSON-LD", "topics": [ "metadata_jsonld" ] }, { "page": "metadata_list", "title": "Metadata from dataframe", "topics": [ "metadata_list" ] }, { "page": "modified", "title": "How many surveys were modified?", "topics": [ "modified" ] }, { "page": "new_codebook_rmd", "title": "Create a codebook rmarkdown document", "topics": [ "new_codebook_rmd" ] }, { "page": "plot_labelled", "title": "Plot labelled vector", "topics": [ "plot_labelled" ] }, { "page": "rescue_attributes", "title": "Rescue lost attributes", "topics": [ "rescue_attributes" ] }, { "page": "reverse_labelled_values", "title": "Reverse labelled values reverse the underlying values for a numeric 'haven::labelled()' vector while keeping the labels correct", "topics": [ "reverse_labelled_values" ] }, { "page": "skim_codebook", "title": "Skim codebook", "topics": [ "skim_codebook" ] }, { "page": "to_factor", "title": "To factor", "topics": [ "to_factor" ] }, { "page": "zap_attributes", "title": "Zap attributes", "topics": [ "zap_attributes" ] }, { "page": "zap_labelled", "title": "Zap labelled class", "topics": [ "zap_labelled" ] } ], "_readme": "https://github.com/rubenarslan/codebook/raw/HEAD/README.md", "_rundeps": [ "base64enc", "bit", "bit64", "cli", "clipr", "codetools", "cpp11", "crayon", "digest", "dplyr", "evaluate", "farver", "fastmap", "forcats", "future", "generics", "ggplot2", "globals", "glue", "GPArotation", "gridExtra", "gtable", "haven", "highr", "hms", "htmltools", "isoband", "jsonlite", "knitr", "labeling", "labelled", "lattice", "lifecycle", "likert", "listenv", "magrittr", "mnormt", "nlme", "parallelly", "pillar", "pkgconfig", "plyr", "prettyunits", "progress", "psych", "purrr", "R6", "RColorBrewer", "Rcpp", "readr", "repr", "reshape2", "rlang", "rmdpartials", "S7", "scales", "skimr", "stringi", "stringr", "tibble", "tidyr", "tidyselect", "tzdb", "utf8", "vctrs", "viridisLite", "vroom", "withr", "xfun", "xtable", "yaml" ], "_vignettes": [ { "source": "codebook_qualtrics.Rmd", "filename": "codebook_qualtrics.html", "title": "Codebook example with Qualtrics dataset", "author": "Ruben Arslan", "engine": "knitr::rmarkdown", "headings": [ "Load" ], "created": "2018-08-01 12:37:55", "modified": "2020-06-05 15:19:45", "commits": 9 }, { "source": "codebook_sav.Rmd", "filename": "codebook_sav.html", "title": "Codebook example with SPSS dataset", "author": "Ruben Arslan", "engine": "knitr::rmarkdown", "headings": [], "created": "2018-08-01 12:37:55", "modified": "2026-03-02 14:05:09", "commits": 13 }, { "source": "codebook_tutorial.Rmd", "filename": "codebook_tutorial.html", "title": "Tutorial", "author": "Ruben Arslan", "engine": "knitr::rmarkdown", "headings": [ "Loading data", "Adding and changing metadata", "Variable labels", "Value labels", "Adding scales", "Metadata about the entire dataset", "Exporting and sharing the data with metadata", "Releasing the codebook publicly", "The Codebook" ], "created": "2018-10-23 11:08:20", "modified": "2026-03-02 14:05:09", "commits": 17 }, { "source": "codebook.Rmd", "filename": "codebook.html", "title": "Codebook example with formr.org data", "author": "Ruben Arslan", "engine": "knitr::rmarkdown", "headings": [], "created": "2018-03-15 10:55:39", "modified": "2024-10-14 14:34:12", "commits": 13 } ], "_score": 8.398287305357401, "_indexed": true, "_nocasepkg": "codebook", "_universes": [ "rubenarslan" ], "_binaries": [ { "r": "4.7.0", "os": "linux", "version": "0.10.1", "date": "2026-05-31T07:25:08.000Z", "distro": "noble", "commit": "6433edb323f50b7d1737b5b91277f1f129162eb2", "fileid": "f29cd3c5729e73bcbd770051062861ca09efa60b969498f4af92cccfd35e1ec7", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025" }, { "r": "4.6.0", "os": "linux", "version": "0.10.1", "date": "2026-05-31T07:25:07.000Z", "distro": "noble", "commit": "6433edb323f50b7d1737b5b91277f1f129162eb2", "fileid": "bae6c2eaf496f0dfcec7e878a55f26a30d218fb13de47db9ab0960b67c52c476", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025" }, { "r": "4.5.3", "os": "mac", "version": "0.10.1", "date": "2026-05-31T07:56:46.000Z", "commit": "6433edb323f50b7d1737b5b91277f1f129162eb2", "fileid": "3f89b9c3f5d0cf3301383fe053be0852dca013d7f5719ae12a47b1eb5710fab5", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025" }, { "r": "4.6.0", "os": "mac", "version": "0.10.1", "date": "2026-05-31T07:57:47.000Z", "commit": "6433edb323f50b7d1737b5b91277f1f129162eb2", "fileid": "e19424ec964dca49bc5f93679af41f656872ed13ae254c020ef057694163f55c", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025" }, { "r": "4.6.0", "os": "wasm", "version": "0.10.1", "date": "2026-05-31T07:25:14.000Z", "commit": "6433edb323f50b7d1737b5b91277f1f129162eb2", "fileid": "4f3b6d014850408e248922e38a106c9c81ac349c6eb1f1368a2eaef5b7dbba39", "status": "success", "buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025" }, { "r": "4.7.0", "os": "win", "version": "0.10.1", "date": "2026-05-31T07:23:59.000Z", "commit": "6433edb323f50b7d1737b5b91277f1f129162eb2", "fileid": "5c307f9dbfe6bb608ae0a2a05313e501f9b3dac55a001018fa17cb7221d74dab", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025" }, { "r": "4.5.3", "os": "win", "version": "0.10.1", "date": "2026-05-31T07:23:55.000Z", "commit": "6433edb323f50b7d1737b5b91277f1f129162eb2", "fileid": "0f2ba7dff2ffabddc30785ed16feaedec1bdc35ea3ac1dc09de02d59e83c37af", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025" }, { "r": "4.6.0", "os": "win", "version": "0.10.1", "date": "2026-05-31T07:23:57.000Z", "commit": "6433edb323f50b7d1737b5b91277f1f129162eb2", "fileid": "e5bbc2823244bdb5d679389ba0ac55b962fef4bbd0f132b42bf61ab9020bd030", "status": "success", "check": "OK", "buildurl": "https://github.com/r-universe/rubenarslan/actions/runs/26706311025" } ] }