intsvy.config: Config files for intsvy studies

View source: R/intsvy.config.R

intsvy.configR Documentation

Config files for intsvy studies

Description

intsvy.config set non standard parameters for intsvy functions. It allso allo to apply intsvy functions to new studies that are similar to PIRLS, TIMSS, PISA, PIAAC, ICILS.

Usage

intsvy.config(variables.pvlabelpref,
           variables.pvlabelsuff,
           variables.weight,
           variables.jackknifeZone,
           variables.jackknifeRep,
           parameters.cutoffs,
           parameters.cutoffs2,
           parameters.percentiles,
           parameters.weights,
           parameters.PVreps,
           parameters.varpv1,
           input.type,
           input.prefixes,
           input.student,
           input.student_colnames1,
           input.student_colnames2,
           input.student_pattern,
           input.homeinput,
           input.home_colnames,
           input.school,
           input.school_colnames,
           input.teacher,
           input.teacher_colnames,
           input.student_ids,
           input.school_ids,
           input.type_part,
           input.cnt_part, base.config = pirls_conf)

Arguments

parameters.weights

Weighting scheme. It may be "JK" for studies like PIRLS, ICLS, TIMSS, or "BRR" for studies like PISA or "mixed_piaac" for studies with mixed design like PIAAC.

parameters.cutoffs2, parameters.cutoffs

Cut offs for plausible values, either for benchmar or for logistic regression.

parameters.percentiles, parameters.PVreps

Other parameters for weighting schemes, like number of PVs.

parameters.varpv1

Logical value, TRUE if only 1 plausible value for within variance estimation.

variables.pvlabelpref, variables.pvlabelsuff, variables.weight, variables.jackknifeZone, variables.jackknifeRep

Names of variables that are used for jack-knife replicates.

input.type, input.prefixes, input.student, input.student_colnames1, input.student_colnames2, input.student_pattern, input.homeinput, input.home_colnames, input.school, input.school_colnames, input.teacher, input.teacher_colnames, input.student_ids, input.school_ids, input.type_part, input.cnt_part

Parameters to correctly read data from files downloaded from iea.nl website.

base.config

Base config structure, either pirls_conf, pisa_conf, piaac_conf, timss4_conf, timss8_conf, icils_conf.

Value

intsvy.config returns new object with parameters. It is a list with three components - input, variables and parameters.

Examples

## Not run: 
icils_conf <- intsvy.config(input.student_pattern = "^PV[0-5]CIL$" , 
                            parameters.cutoffs2 = 550, intsvy:::pirls_conf)
icils_conf

## End(Not run)

intsvy documentation built on Aug. 6, 2022, 5:06 p.m.