REDCapCAST/man/easy_redcap.Rd

44 lines
1 KiB
Text
Raw Normal View History

% 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{
2025-03-05 13:41:08 +01:00
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
2024-11-28 14:32:03 +01:00
\link[keyring]{key_set}, using the default keyring)}
2024-02-05 14:46:20 +01:00
\item{uri}{REDCap database API uri}
2025-01-29 10:04:38 +01:00
\item{raw_or_label}{argument passed on to
\link[REDCapCAST]{read_redcap_tables}. Default is "both" to get labelled
data.}
2025-03-05 13:41:08 +01:00
\item{data_format}{Choose the data}
\item{widen.data}{argument to widen the exported data. [DEPRECATED], use
`data_format`instead}
2024-11-28 14:32:03 +01:00
\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
}
2024-11-28 14:32:03 +01:00
\examples{
\dontrun{
2025-01-29 10:04:38 +01:00
easy_redcap("My_new_project", fields = c("record_id", "age", "hypertension"))
2024-11-28 14:32:03 +01:00
}
}