Skip to contents

Compute age of onset use for a given substance

Source: R/scores_su_sui_tlfb.R
compute_su_y_sui__onset_useage.Rd

Computes the age (in years) of onset use of a given substance. Returns NA for the participants with no onset use of the provided substance reported.

Usage

sui_substances

compute_su_y_sui__onset_useage(data, name, substance, combine = TRUE)

Format

sui_substances is a character vector of substances keywords.

Arguments

data

tibble. A data frame containing the data.

name

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

substance

character (vector). The substance to compute the score for. Must be one of the following values:

  • "alc"

  • "alc__sip"

  • "rxstim"

  • "cath"

  • "cbd"

  • "coc"

  • "dxm"

  • "ghb"

  • "hall"

  • "inh"

  • "ket"

  • "meth"

  • "mdma"

  • "mj__blunt"

  • "mj__conc"

  • "mj__conc__smoke"

  • "mj__conc__vape"

  • "mj__drink"

  • "mj__edbl"

  • "mj__smoke"

  • "mj__vape"

  • "mj__synth"

  • "mj__tinc"

  • "nic__chew"

  • "nic__cigar"

  • "nic__cig"

  • "nic__hookah"

  • "nic__pipe"

  • "nic__rplc"

  • "nic__vape"

  • "opi"

  • "othdrg"

  • "qc"

  • "roid"

  • "rxopi"

  • "salv"

  • "shroom"

  • "rxsed"

  • "vape"

  • "vape__flav"

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.

Examples

if (FALSE) { # \dontrun{
compute_su_y_sui__onset_useage(
  data = data_sui,
  name = "su_y_sui__alc__onset_useage",
  substance = "alc"
)
} # }