Skip to contents

Compute "Family History [Parent] (Mania) Endorsed: Parents overall"

Source: R/scores_mh_famhx.R
compute_mh_p_famhx__mania__moth__fath_score.Rd

Computes the summary score mh_p_famhx__mania__moth__fath_score (Family History [Parent] (Mania) Endorsed: Parents overall)

  • Excluded values:

    • 777

    • 888

    • 999

  • Notes:

    • Following logic is applied to compute the score:

      • father endorsed no AND mother endorsed no = 0

      • father endorsed yes AND mother endorsed no = 1

      • father endorsed no AND mother endorsed yes = 2

      • father endorsed yes AND mother endorsed yes = 3

      • father endorsed NA AND mother endorsed yes = 4

      • father endorsed yes AND mother endorsed NA = 5

      • all other cases set to NA

Usage

vars_mh_p_famhx__mania__moth__fath_score

compute_mh_p_famhx__mania__moth__fath_score(
  data,
  name = "mh_p_famhx__mania__moth__fath_score",
  exclude = c("777", "888", "999"),
  combine = TRUE
)

Format

a character vector of base name of the check boxes used to compute mh_p_famhx__mania__moth__fath_score.

Arguments

data

tibble. A data frame containing the data.

name

character. The name of the output column for the computed score.

exclude

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

combine

logical. Whether to combine the summary score column with the input data frame (Default: TRUE).

Value

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