REDCapCAST/man/read_redcap_tables.Rd

54 lines
1.3 KiB
Plaintext
Raw Normal View History

2023-02-28 09:54:03 +01:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/read_redcap_tables.R
\name{read_redcap_tables}
\alias{read_redcap_tables}
\title{Download REDCap data}
\usage{
read_redcap_tables(
uri,
token,
records = NULL,
fields = NULL,
events = NULL,
forms = NULL,
raw_or_label = "label",
split_forms = "all",
2023-02-28 09:54:03 +01:00
generics = c("record_id", "redcap_event_name", "redcap_repeat_instrument",
"redcap_repeat_instance")
2023-02-28 09:54:03 +01:00
)
}
\arguments{
\item{uri}{REDCap database uri}
\item{token}{API token}
\item{records}{records to download}
\item{fields}{fields to download}
\item{events}{events to download}
\item{forms}{forms to download}
\item{raw_or_label}{raw or label tags}
2023-04-13 10:57:04 +02:00
\item{split_forms}{Whether to split "repeating" or "all" forms, default is
all.}
2023-02-28 09:54:03 +01:00
\item{generics}{vector of auto-generated generic variable names to
ignore when discarding empty rows}
}
\value{
list of instruments
}
\description{
Implementation of REDCap_split with a focused data acquisition approach using
REDCapR::redcap_read and only downloading specified fields, forms and/or
2023-04-13 10:57:04 +02:00
events using the built-in focused_metadata including some clean-up.
Works with classical and longitudinal projects with or without repeating
instruments.
2023-02-28 09:54:03 +01:00
}
\examples{
# Examples will be provided later
}