andreas/REDCapCAST
1
0
Fork 0
mirror of https://github.com/agdamsbo/REDCapCAST.git synced 2024-11-21 21:10:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

unified parameter naming

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
R/read_redcap_instrument.R
View File

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

2
R/read_redcap_tables.R
View File

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

4
man/read_redcap_instrument.Rd
View File

@ -7,7 +7,7 @@
read_redcap_instrument( read_redcap_instrument(
key, key,
uri, uri,
instrument = "rbans", instrument,
raw_or_label = "raw", raw_or_label = "raw",
id_name = "record_id", id_name = "record_id",
records = NULL records = NULL
@ -16,7 +16,7 @@ read_redcap_instrument(
\arguments{ \arguments{
\item{key}{key name in standard keyring for token retrieval.} \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} \item{instrument}{instrument name}

2
man/read_redcap_tables.Rd
View File

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