mirror of
https://github.com/agdamsbo/REDCapCAST.git
synced 2025-04-02 22:22:33 +02:00
44 lines
1.0 KiB
R
44 lines
1.0 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/easy_redcap.R
|
|
\name{easy_redcap}
|
|
\alias{easy_redcap}
|
|
\title{Secure API key storage and data acquisition in one}
|
|
\usage{
|
|
easy_redcap(
|
|
project.name,
|
|
uri,
|
|
raw_or_label = "both",
|
|
data_format = c("wide", "list", "redcap", "long"),
|
|
widen.data = NULL,
|
|
...
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{project.name}{The name of the current project (for key storage with
|
|
\link[keyring]{key_set}, using the default keyring)}
|
|
|
|
\item{uri}{REDCap database API uri}
|
|
|
|
\item{raw_or_label}{argument passed on to
|
|
\link[REDCapCAST]{read_redcap_tables}. Default is "both" to get labelled
|
|
data.}
|
|
|
|
\item{data_format}{Choose the data}
|
|
|
|
\item{widen.data}{argument to widen the exported data. [DEPRECATED], use
|
|
`data_format`instead}
|
|
|
|
\item{...}{arguments passed on to \link[REDCapCAST]{read_redcap_tables}.}
|
|
}
|
|
\value{
|
|
data.frame or list depending on widen.data
|
|
}
|
|
\description{
|
|
Secure API key storage and data acquisition in one
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
easy_redcap("My_new_project", fields = c("record_id", "age", "hypertension"))
|
|
}
|
|
}
|