SocEpi (version 1.0.0)

zscore: z-scores

Description

zscores calculates standardized scores or z-scores, with a mean close to zero and standard deviation (sd) close to one, for the variable given in variable. The standardization uses a population weighted mean and standard deviation, which are calculated based on the population distribution given by population.

Usage

zscore(population, variable)

Arguments

population

Population counts.

variable

Continuous deprivation measure, such as a percentage, to calculate the z-scores for.

Value

A list including the following:

z.score

standardized score using weighted mean and sd

w.mean

weighted mean

w.sd

weighted standard deviation

weight

population weight

Examples

# NOT RUN {
data <- dep_data

# store all results in object z_oc
z_oc <- zscore(data$total_pop, data$pcnt_overcrowding)

# extract z-score
data$z_overcrowd <- z_oc$z.score
mean(data$z_overcrowd) # mean of z-score
sd(data$z_overcrowd) # sd z-score

# extract weighted mean and sd, compare weighted values to unweighted values
mean(data$pcnt_overcrowding)
z_oc$w.mean
sd(data$pcnt_overcrowding)
z_oc$w.sd

# }