transformPvs {conquestr}R Documentation

transformPvs

Description

Helper function to Transform PVs onto a new metric (e.g., PISA Mean = 500, SD = 100). Uses the method described in the PISA 2012 technical manual.

Usage

transformPvs(x, mT = 0, sdT = 1, weights, data, addToDf = FALSE, debug = TRUE)

Arguments

x

A concatenated vector of varnames in data, PV1, PV2, ..., PVm.

mT

The desired mean of the PVs

sdT

The desired sd of the PVs

weights

The name of the weight variable in 'data' used to caulculate the mean and SD accross the PVs

data

The data frame that contains the PVs and weights.

addToDf

A Boolean, if TRUE, the transformed PVs are coerced into the DF, data, with name data$x_T (not yet implmented).

debug

A temporary flag to spit-out objects to global env for chekcing. Will be removed when pushed to CRAN

Value

a List of transofrmed PVs with as many elements as PVs were listed in 'x'.


[Package conquestr version 1.3.0 Index]