Skip to contents

Compute "School Risk & Protective Factors [Youth] (School environment): Mean"

Source: R/scores_fc.R
compute_fc_y_srpf__env_mean.Rd

Computes the summary score fc_y_srpf__env_mean (School Risk & Protective Factors [Youth] (School environment): Mean)

  • Summarized variables:

    • fc_y_srpf__env_001

    • fc_y_srpf__env_002

    • fc_y_srpf__env_003

    • fc_y_srpf__env_004

    • fc_y_srpf__env_005

    • fc_y_srpf__env_006

  • Excluded values:

    • 777

  • Validation criterion: maximally 1 of 6 items missing

Usage

vars_fc_y_srpf__env

compute_fc_y_srpf__env_mean(
  data,
  name = "fc_y_srpf__env_mean",
  max_na = 1,
  exclude = c("777"),
  combine = TRUE
)

Format

vars_fc_y_srpf__env is a character vector of all column names used to compute summary score of fc_y_srpf__env.

Arguments

data

tbl. Data frame containing the columns to be summarized.

name

character. Name of the summary score. Default is the name in the description.

max_na

numeric, positive whole number. Number of missing items allowed (Default: 1).

exclude

character vector. Values to be excluded from the summary score calculation.

combine

logical. If TRUE, the summary score is appended to the input data frame. If FALSE, the summary score is returned as a separate data frame. Default is TRUE.

Value

tbl. The input data frame with the summary score appended as a new column.