codebook/docs/reference/codebook.html at master · rubenarslan/codebook · GitHub

History

170 lines (123 loc) · 12.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

<!DOCTYPE html>

<html lang="en-GB"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Generate rmarkdown codebook — codebook • codebook</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><script src="../pkgdown.js"></script><meta property="og:title" content="Generate rmarkdown codebook — codebook"><meta name="description" content="Pass a data frame to this function to make a codebook for that dataset.

If the dataset has metadata (attributes) set on its variables, these will be

used to make the codebook more informative. Examples are item, value, and

missing labels.

Data frames imported via haven::read_dta(), haven::read_sav(), or from

formr.org will have these attributes in the right format.

By calling this function inside a knitr code chunk, the

codebook will become part of the document you are generating."><meta property="og:description" content="Pass a data frame to this function to make a codebook for that dataset.

If the dataset has metadata (attributes) set on its variables, these will be

used to make the codebook more informative. Examples are item, value, and

missing labels.

Data frames imported via haven::read_dta(), haven::read_sav(), or from

formr.org will have these attributes in the right format.

By calling this function inside a knitr code chunk, the

codebook will become part of the document you are generating."><meta name="twitter:card" content="summary"><meta name="twitter:creator" content="@rubenarslan"><meta name="twitter:site" content="@rubenarslan"></head><body>

<a href="#main" class="visually-hidden-focusable">Skip to contents</a>

<a class="navbar-brand me-2" href="../index.html">codebook</a>

</button>

<ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/codebook.html">Get started</a></li>

<li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>

<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>

<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/codebook_qualtrics.html">Codebook example with Qualtrics dataset</a></li>

<li><a class="dropdown-item" href="../articles/codebook_sav.html">Codebook example with SPSS dataset</a></li>

<li><a class="dropdown-item" href="../articles/codebook_tutorial.html">Tutorial</a></li>

</ul></li>

<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>

</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">

</ul></div>

</div>

</nav><div class="container template-reference-topic">

<h1>Generate rmarkdown codebook</h1>

<small class="dont-index">Source: <a href="https://github.com/rubenarslan/codebook/blob/HEAD/R/codebook.R" class="external-link"><code>R/codebook.R</code></a></small>

<div class="d-none name"><code>codebook.Rd</code></div>

</div>

<p>Pass a data frame to this function to make a codebook for that dataset.

If the dataset has metadata (attributes) set on its variables, these will be

used to make the codebook more informative. Examples are item, value, and

missing labels.

Data frames imported via <code><a href="https://haven.tidyverse.org/reference/read_dta.html" class="external-link">haven::read_dta()</a></code>, <code><a href="https://haven.tidyverse.org/reference/read_spss.html" class="external-link">haven::read_sav()</a></code>, or from

<a href="https://formr.org" class="external-link">formr.org</a> will have these attributes in the right format.

By calling this function inside a knitr code chunk, the

codebook will become part of the document you are generating.</p>

</div>

<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>

<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">codebook</span><span class="op">(</span></span>

<span> <span class="va">results</span>,</span>

<span> reliabilities <span class="op">=</span> <span class="cn">NULL</span>,</span>

<span> survey_repetition <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"auto"</span>, <span class="st">"single"</span>, <span class="st">"repeated_once"</span>, <span class="st">"repeated_many"</span><span class="op">)</span>,</span>

<span> detailed_variables <span class="op">=</span> <span class="cn">TRUE</span>,</span>

<span> detailed_scales <span class="op">=</span> <span class="cn">TRUE</span>,</span>

<span> survey_overview <span class="op">=</span> <span class="cn">TRUE</span>,</span>

<span> missingness_report <span class="op">=</span> <span class="cn">TRUE</span>,</span>

<span> metadata_table <span class="op">=</span> <span class="cn">TRUE</span>,</span>

<span> metadata_json <span class="op">=</span> <span class="cn">TRUE</span>,</span>

<span> exclude_from_detailed_display <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="op">)</span>,</span>

<span> indent <span class="op">=</span> <span class="st">"#"</span></span>

</div>

<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>

<dl><dt id="arg-results">results<a class="anchor" aria-label="anchor" href="#arg-results"></a></dt>

<dd><p>a data frame, ideally with attributes set on variables</p></dd>

<dt id="arg-reliabilities">reliabilities<a class="anchor" aria-label="anchor" href="#arg-reliabilities"></a></dt>

<dd><p>a named list with one entry per scale and one or several printable reliability computations for this scale. if NULL, computed on-the-fly using compute_reliabilities</p></dd>

<dt id="arg-survey-repetition">survey_repetition<a class="anchor" aria-label="anchor" href="#arg-survey-repetition"></a></dt>

<dd><p>defaults to "auto" which is to try to determine the level of repetition from the "session" and "created" variables. Other values are: single, repeated_once, repeated_many</p></dd>

<dt id="arg-detailed-variables">detailed_variables<a class="anchor" aria-label="anchor" href="#arg-detailed-variables"></a></dt>

<dd><p>whether to print a graph and summary for each variable</p></dd>

<dt id="arg-detailed-scales">detailed_scales<a class="anchor" aria-label="anchor" href="#arg-detailed-scales"></a></dt>

<dd><p>whether to print a graph and summary for each scale</p></dd>

<dt id="arg-survey-overview">survey_overview<a class="anchor" aria-label="anchor" href="#arg-survey-overview"></a></dt>

<dd><p>whether to print an overview of survey entries, durations (depends on presence of columns session, created, modified, ended, expired)</p></dd>

<dt id="arg-missingness-report">missingness_report<a class="anchor" aria-label="anchor" href="#arg-missingness-report"></a></dt>

<dd><p>whether to print a missingness report. Turn off if this gets too complicated and you need a custom solution (e.g. in case of random missings).</p></dd>

<dt id="arg-metadata-table">metadata_table<a class="anchor" aria-label="anchor" href="#arg-metadata-table"></a></dt>

<dd><p>whether to print a metadata table/tabular codebook.</p></dd>

<dt id="arg-metadata-json">metadata_json<a class="anchor" aria-label="anchor" href="#arg-metadata-json"></a></dt>

<dd><p>whether to include machine-readable metadata as JSON-LD (not visible)</p></dd>

<dt id="arg-exclude-from-detailed-display">exclude_from_detailed_display<a class="anchor" aria-label="anchor" href="#arg-exclude-from-detailed-display"></a></dt>

<dd><p>a character vector of variable names to exclude from the detailed graphical display. These variables will still appear in the metadata table and JSON-LD metadata, but no distribution plots or summary statistics will be generated for them.</p></dd>

<dt id="arg-indent">indent<a class="anchor" aria-label="anchor" href="#arg-indent"></a></dt>

<dd><p>add # to this to make the headings in the components lower-level. defaults to beginning at h2</p></dd>

</dl></div>

<p>When rendering to PDF/LaTeX, JSON-LD metadata (<code>metadata_json</code>) is

automatically disabled because it relies on HTML <code><script></code> tags. The

metadata table (<code>metadata_table</code>) switches from an interactive HTML widget

to a static table via <code><a href="https://rdrr.io/pkg/knitr/man/kable.html" class="external-link">knitr::kable()</a></code>.</p>

</div>

<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>

<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># will generate figures in a temporary directory</span></span></span>

<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span></span>

<span class="r-in"><span><span class="va">md</span> <span class="op"><-</span> <span class="fu">codebook</span><span class="op">(</span><span class="va">bfi</span>, survey_repetition <span class="op">=</span> <span class="st">"single"</span>, metadata_table <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span>

</code></pre></div>

</div>

</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>

</nav></aside></div>

<p>Developed by Ruben Arslan.</p>

</div>

<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.2.0.</p>

</div>

</footer></div>

</body></html>

codebook/docs/reference/codebook.html at master · rubenarslan/codebook · GitHub

Expand file tree

Breadcrumbs

codebook.html

Latest commit

History

Breadcrumbs

codebook.html

File metadata and controls