Description Usage Arguments Value Examples
Function codebook
collects documentation about an item,
or the items in a data set or external data file. It returns
an object that, when show
n, print this documentation
in a nicely formatted way.
1 2 3 4 5 6 7 8 9 10 11 12 13 | codebook(x)
## S4 method for signature 'item'
codebook(x)
## S4 method for signature 'atomic'
codebook(x)
## S4 method for signature 'factor'
codebook(x)
## S4 method for signature 'data.set'
codebook(x)
## S4 method for signature 'data.frame'
codebook(x)
## S4 method for signature 'importer'
codebook(x)
|
x |
an |
An object of class "codebook", for which a show
method exists that
produces a nicely formatted output.
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 41 42 43 44 45 46 47 48 49 50 | Data <- data.set(
vote = sample(c(1,2,3,8,9,97,99),size=300,replace=TRUE),
region = sample(c(rep(1,3),rep(2,2),3,99),size=300,replace=TRUE),
income = exp(rnorm(300,sd=.7))*2000
)
Data <- within(Data,{
description(vote) <- "Vote intention"
description(region) <- "Region of residence"
description(income) <- "Household income"
wording(vote) <- "If a general election would take place next tuesday,
the candidate of which party would you vote for?"
wording(income) <- "All things taken into account, how much do all
household members earn in sum?"
foreach(x=c(vote,region),{
measurement(x) <- "nominal"
})
measurement(income) <- "ratio"
labels(vote) <- c(
Conservatives = 1,
Labour = 2,
"Liberal Democrats" = 3,
"Don't know" = 8,
"Answer refused" = 9,
"Not applicable" = 97,
"Not asked in survey" = 99)
labels(region) <- c(
England = 1,
Scotland = 2,
Wales = 3,
"Not applicable" = 97,
"Not asked in survey" = 99)
foreach(x=c(vote,region,income),{
annotation(x)["Remark"] <- "This is not a real survey item, of course ..."
})
missing.values(vote) <- c(8,9,97,99)
missing.values(region) <- c(97,99)
})
description(Data)
codebook(Data)
## Not run:
Write(descrition(Data),
file="Data-desc.txt")
Write(codebook(Data),
file="Data-cdbk.txt")
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.