Skip to contents

Gets ADNI Screening Date

Source: R/enrollment-utils.R
get_adni_screen_date.Rd

This function is used to extract subject screening date in the ADNI study.

Usage

get_adni_screen_date(
  .registry,
  phase = "Overall",
  both = FALSE,
  multiple_screen_visit = FALSE
)

Arguments

.registry

Data.frame of REGISTRY eCRF

phase

Either `Overall` or phase-specific screening date, Default: 'Overall'

both

A Boolean value to include both overall and phase-specific enrollment list, Default: FALSE

multiple_screen_visit

A Boolean value to include multiple screen visits in ADNIGO and ADNI2 phases, Default: FALSE

Value

  • If `both = TRUE`: a list of data frames that includes both overall (`overall_screen`) and phase-specific enrollment (`phase_screen`)

  • Otherwise a data frame corresponding to the provided input arguments:

    • Overall screen if `phase = "Overall"` and will contains one records per subject regardless the value of `multiple_screen_visit`

    • Phase specific screen if `phase != "Overall"` and will contains one records per subject if `multiple_screen_visit = FALSE`.

  • The data frame will contains `RID`, `ORIGPROT`, `COLPROT`, and `SCREENDATE` variables. The data frame will contains `VISCODE` for `multiple_screen_visit = TRUE`

See also

get_adni_enrollment()

Examples

if (FALSE) { # \dontrun{
# Overall screening: when subject screened for the first time in ADNI study.
overall_screen_registry <- get_adni_screen_date(
  .registry = ADNIMERGE2::REGISTRY,
  phase = "Overall",
  both = FALSE,
  multiple_screen_visit = FALSE
)
# Phase-specific screening: when subject screened for the first time in ADNI3 study phase.
adni3_screen_registry <- get_adni_screen_date(
  .registry = ADNIMERGE2::REGISTRY,
  phase = "ADNI3",
  both = FALSE,
  multiple_screen_visit = FALSE
)
# Multiple screen visits in each ADNIGO and ADNI2 study phases.
adnigo2_screen_registry <- get_adni_screen_date(
  .registry = ADNIMERGE2::REGISTRY,
  phase = c("ADNIGO", "ADNI2"),
  both = FALSE,
  multiple_screen_visit = TRUE
)
# Screening across each ADNI phases
phase_screen_registry <- get_adni_screen_date(
  .registry = ADNIMERGE2::REGISTRY,
  phase = ADNIMERGE2::adni_phase(),
  both = FALSE,
  multiple_screen_visit = FALSE
)
# Overall and phase-specific screening
both_screen_registry <- get_adni_screen_date(
  .registry = ADNIMERGE2::REGISTRY,
  phase = "Overall",
  both = TRUE,
  multiple_screen_visit = FALSE
)
} # }