import_participants: Import participant demographics

View source: R/import_data.R

import_participantsR Documentation

Import participant demographics

Description

import_participants Access the participant information that should be constant across all sessions (for example, age at diagnosis, sex, etc).

Usage

import_participants(anon_id = FALSE, identifiers = FALSE)

Arguments

anon_id

If TRUE, return an anonymised subject_id. Otherwise, return the in-house, non-secure ID. Currently, this option is not useful if other datasets are being imported, as they still contain the standard ID. We need to implement a global setting that dictates whether all functions return anonymised IDs.

identifiers

If TRUE, include identifying information (names, dates of birth & death, etc). This should not be used routinely for research. i.e. this information should only ever be needed for study management purposes. anon_id must be set to FALSE for this parameter to have any effect.

Details

This information is exported periodically from the Alice database.

Value

A dataframe containing the participant data.

Examples

## Not run: 
participants <- import_participants()

## End(Not run)

nzbri/chchpd documentation built on July 6, 2023, 11:27 p.m.