From 904b76eb967b15b901ef6556d581038129daa5ba Mon Sep 17 00:00:00 2001 From: Andreas Gammelgaard Damsbo Date: Mon, 5 Feb 2024 14:46:37 +0100 Subject: [PATCH] unified parameter naming --- R/read_redcap_instrument.R | 4 ++-- R/read_redcap_tables.R | 2 +- man/read_redcap_instrument.Rd | 4 ++-- man/read_redcap_tables.Rd | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/read_redcap_instrument.R b/R/read_redcap_instrument.R index a9d2dd9..ed1e7fd 100644 --- a/R/read_redcap_instrument.R +++ b/R/read_redcap_instrument.R @@ -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) { diff --git a/R/read_redcap_tables.R b/R/read_redcap_tables.R index a9f9e62..3975bc6 100644 --- a/R/read_redcap_tables.R +++ b/R/read_redcap_tables.R @@ -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 diff --git a/man/read_redcap_instrument.Rd b/man/read_redcap_instrument.Rd index 8ef6792..1736b94 100644 --- a/man/read_redcap_instrument.Rd +++ b/man/read_redcap_instrument.Rd @@ -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} diff --git a/man/read_redcap_tables.Rd b/man/read_redcap_tables.Rd index c2c36a8..7e0f5cc 100644 --- a/man/read_redcap_tables.Rd +++ b/man/read_redcap_tables.Rd @@ -18,7 +18,7 @@ read_redcap_tables( ) } \arguments{ -\item{uri}{REDCap database uri} +\item{uri}{REDCap database API uri} \item{token}{API token}