R/qs_metabolic.R

In pharmaversesdtm: SDTM Test Data for the 'Pharmaverse' Family of Packages

# This file is automatically generated by data-raw/create_sdtms_data.R.
# For updating it please edit inst/extdata/sdtms-specs.json and rerun create_sdtms_data.R.
# Manual edits are not recommended, as changes may be overwritten.
#' Questionnaire Dataset-metabolic
#'
#' A SDTM QS dataset containing COEQ data (Control of Eating Questionnaire) for metabolic studies. Note that University of Leeds are the copyright holders of the Control of Eating Questionnaire (CoEQ) and the test data included within pharmaversesdtm as well as the ADCOEQ code are for not-for-profit use only within admiralmetabolic and pharmaverse-related examples/documentation. Any persons or companies wanting to use the CoEQ should request a license to do so from the following [link](https://licensing.leeds.ac.uk/product/control-of-eating-questionnaire-coeq).
#'
#' @name qs_metabolic
#' @title Questionnaire Dataset-metabolic
#' @keywords dataset
#' @description A SDTM QS dataset containing COEQ data (Control of Eating Questionnaire) for metabolic studies. Note that University of Leeds are the copyright holders of the Control of Eating Questionnaire (CoEQ) and the test data included within pharmaversesdtm as well as the ADCOEQ code are for not-for-profit use only within admiralmetabolic and pharmaverse-related examples/documentation. Any persons or companies wanting to use the CoEQ should request a license to do so from the following [link](https://licensing.leeds.ac.uk/product/control-of-eating-questionnaire-coeq).
#' @docType data
#' @format A data frame with 18 columns:
#'   \describe{
#'     \item{STUDYID}{Study Identifier}
#'     \item{USUBJID}{Unique Subject Identifier}
#'     \item{DOMAIN}{Domain Abbreviation}
#'     \item{VISIT}{Visit Name}
#'     \item{VISITNUM}{Visit Number}
#'     \item{VISITDY}{Planned Study Day of Visit}
#'     \item{QSBLFL}{Baseline Flag}
#'     \item{QSDTC}{Date/Time of Finding}
#'     \item{QSDY}{Study Day of Finding}
#'     \item{QSCAT}{Category for Questionnaire}
#'     \item{QSTEST}{Questionnaire Test Name}
#'     \item{QSTESTCD}{Questionnaire Test Short Name}
#'     \item{QSORRES}{Result or Finding in Original Units}
#'     \item{QSORRESU}{Original Units}
#'     \item{QSSTRESC}{Character Result/Finding in Std Format}
#'     \item{QSSTRESN}{Numeric Result/Finding in Standard Units}
#'     \item{QSSTRESU}{Standard Units}
#'     \item{QSSEQ}{Sequence Number}
#'   }
#'
#' @source Constructed by {admiralmetabolic} developers
#' @details Contains a set of 21 unique Test Short Names and Test Names: \tabular{ll}{
#'   \strong{QSTESTCD} \tab \strong{QSTEST} \cr
#'   COEQ01 \tab How hungry have you felt?                                                   \cr
#'   COEQ02 \tab How full have you felt?                                                     \cr
#'   COEQ03 \tab How strong was your desire to eat sweet foods?                              \cr
#'   COEQ04 \tab How strong was your desire to eat savoury foods?                            \cr
#'   COEQ05 \tab How happy have you felt?                                                    \cr
#'   COEQ06 \tab How anxious have you felt?                                                  \cr
#'   COEQ07 \tab How alert have you felt?                                                    \cr
#'   COEQ08 \tab How contented have you felt?                                                \cr
#'   COEQ09 \tab During the last 7 days how often have you had food cravings?                \cr
#'   COEQ10 \tab How strong have any food cravings been?                                     \cr
#'   COEQ11 \tab How difficult has it been to resist any food cravings?                      \cr
#'   COEQ12 \tab How often have you eaten in response to food cravings?                      \cr
#'   COEQ13 \tab Chocolate or chocolate flavoured foods                                      \cr
#'   COEQ14 \tab Other sweet foods (cakes, pastries, biscuits, etc)                          \cr
#'   COEQ15 \tab Fruit or fruit juice                                                        \cr
#'   COEQ16 \tab Dairy foods (cheese, yoghurts, milk, etc)                                   \cr
#'   COEQ17 \tab Starchy foods (bread, rice, pasta, etc)                                     \cr
#'   COEQ18 \tab Savoury foods (french fries, crisps, burgers, pizza, etc)                   \cr
#'   COEQ19 \tab Generally, how difficult has it been to control your eating?                \cr
#'   COEQ20 \tab Which one food makes it most difficult for you to control eating?           \cr
#'   COEQ21 \tab How difficult has it been to resist eating this food during the last 7 days?
#' }

"qs_metabolic"