unified parameter naming

This commit is contained in:
Andreas Gammelgaard Damsbo 2024-02-05 14:46:37 +01:00
parent 385973e8da
commit 904b76eb96
4 changed files with 6 additions and 6 deletions

View File

@ -1,7 +1,7 @@
#' Convenience function to download complete instrument, using token storage in keyring.
#'
#' @param key key name in standard keyring for token retrieval.
#' @param uri redcap api url
#' @param uri REDCap database API uri
#' @param instrument instrument name
#' @param raw_or_label raw or label passed to `REDCapR::redcap_read()`
#' @param id_name id variable name. Default is "record_id".
@ -11,7 +11,7 @@
#' @export
read_redcap_instrument <- function(key,
uri,
instrument = "rbans",
instrument,
raw_or_label = "raw",
id_name = "record_id",
records = NULL) {

View File

@ -5,7 +5,7 @@
#' events using the built-in focused_metadata including some clean-up.
#' Works with classical and longitudinal projects with or without repeating
#' instruments.
#' @param uri REDCap database uri
#' @param uri REDCap database API uri
#' @param token API token
#' @param records records to download
#' @param fields fields to download

View File

@ -7,7 +7,7 @@
read_redcap_instrument(
key,
uri,
instrument = "rbans",
instrument,
raw_or_label = "raw",
id_name = "record_id",
records = NULL
@ -16,7 +16,7 @@ read_redcap_instrument(
\arguments{
\item{key}{key name in standard keyring for token retrieval.}
\item{uri}{redcap api url}
\item{uri}{REDCap database API uri}
\item{instrument}{instrument name}

View File

@ -18,7 +18,7 @@ read_redcap_tables(
)
}
\arguments{
\item{uri}{REDCap database uri}
\item{uri}{REDCap database API uri}
\item{token}{API token}