get_instrument_data: Get the Wordbank administration-by-item data

Description Usage Arguments Value Examples

View source: R/wordbankr.R

Description

Get the Wordbank administration-by-item data

Usage

1
2
get_instrument_data(language, form, items = NULL, administrations = FALSE,
  iteminfo = FALSE, mode = "remote")

Arguments

language

A string of the instrument's language (insensitive to case and whitespace).

form

A string of the instrument's form (insensitive to case and whitespace).

items

A character vector of column names of instrument_table of items to extract. If not supplied, defaults to all the columns of instrument_table.

administrations

Either a logical indicating whether to include administration data or a data frame of administration data (from get_administration_data).

iteminfo

Either a logical indicating whether to include item data or a data frame of item data (from get_item_data).

mode

A string indicating connection mode: one of "local", or "remote" (defaults to "remote").

Value

A data frame where each row is the result (value) of a given item (num_item_id) for a given administration (data_id), with additional columns of variables about the administration and item, if specified.

Examples

1
2
3
4
5
6
## Not run: 
eng_ws_data <- get_instrument_data(language = "English (American)",
                                   form = "WS",
                                   items = c("item_1", "item_42"))

## End(Not run)

wordbankr documentation built on March 18, 2018, 1:14 p.m.