File: format_html.codebook.Rd

package info (click to toggle)
r-cran-memisc 0.99.31.8.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,136 kB
  • sloc: ansic: 5,117; makefile: 2
file content (40 lines) | stat: -rw-r--r-- 1,506 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
\name{format_html.codebook}
\alias{format_html.codebook}
\alias{codebook_format_stdstyle}
\title{
  Format Codebooks as HTML
}
\description{
  This is the method of \code{\link{format_html}} for "codebook" objects as created
  by the eponymous function (see \code{\link{codebook}})
}
\usage{
\method{format_html}{codebook}(x, 
    toprule = 2,
    midrule = 1,
    indent = "3ex",
    style = codebook_format_stdstyle,
    var_tag = "code", 
    varid_prefix = "", title_tag = "p",\dots)
}
\arguments{
  \item{x}{a "codebook" object}
  \item{toprule}{a non-negative integer; thickness of the line (in pixels) at the top of each
  codebook entry}
  \item{midrule}{a non-negative integer; thickness of the line (in pixels) that separates the
  header of an codebook entry from its body}
  \item{indent}{character string; indentation (by padding) of the 
    codebook entry contents}
  \item{style}{string containing the standard CSS styling of codebook table cells.}
  \item{var_tag}{character string; the HTML tag that contains the 
  name of the variable}
  \item{varid_prefix}{character string; a prefix added to 
  the anchor IDs of the code entry titles (to facilitate the 
  creation of tables of contents etc.)}
  \item{title_tag}{character string; the HTML tag that contains 
  the title of the codebook entry (the variable name and its description)}
 \item{\dots}{further arguments, ignored.}}
\seealso{
  See Also as \code{\link{format_html}}, \code{\link{show_html}}, \code{\link{write_html}}.
}