import_sessions: Import links between sessions and studies

In nzbri/chchpd: Manage and Manipulate Christchurch Parkinson's Studies Data

Import links between sessions and studies

Description

import_sessions Access a table that links a given session to the (possibly multiple) studies of which it is a part, and the group within that study to which the associated participant belongs.

Usage

import_sessions(
  from_study = NULL,
  exclude = TRUE,
  print_exclude_summary = TRUE
)

Arguments

from_study	Optionally specify the name of a specific study to limit the records returned to just those from that study. Inspect the sessions spreadsheet to see the valid options. e.g. 'PET' or 'Follow-up' for the Progression study. Can also specify a list to include sessions from multiple studies, e.g. c('Follow-up', 'PD DNA').
exclude	If TRUE, don't return sessions that have been excluded from a given study. For safety, we default to TRUE so that you don't get junk data unless you explicitly ask for it. You might set this to FALSE in order to get all records if you need to document exclusions, for example to create a participant recruitment and exclusion flowchart.
print_exclude_summary	If TRUE, print a table that lists the number of records that are excluded from each study. If this looks problematic, you could set exclude = FALSE to import all records to identify which ones were excluded.

Details

This information is exported periodically from the Alice database.

Value

A dataframe containing the session-group-study data.

Examples

## Not run: 
sessions <- import_sessions()

## End(Not run)

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