From f967a9e0239a759af1fbf7f2e190aba04f115676 Mon Sep 17 00:00:00 2001 From: Will Beasley Date: Sun, 13 Oct 2024 09:45:15 -0500 Subject: [PATCH] update docs --- man/metadata_utilities.Rd | 4 ++-- man/redcap_event_instruments.Rd | 8 ++++---- man/redcap_next_free_record_name.Rd | 4 ++-- man/redcap_project.Rd | 4 ++-- man/redcap_project_info_read.Rd | 6 +++--- man/redcap_read.Rd | 4 ++-- man/redcap_read_eav_oneshot.Rd | 4 ++-- man/redcap_read_oneshot.Rd | 4 ++-- man/redcap_read_oneshot_eav.Rd | 4 ++-- man/redcap_report.Rd | 8 ++++---- 10 files changed, 25 insertions(+), 25 deletions(-) diff --git a/man/metadata_utilities.Rd b/man/metadata_utilities.Rd index 2fbd5c07..f76839a3 100644 --- a/man/metadata_utilities.Rd +++ b/man/metadata_utilities.Rd @@ -69,8 +69,8 @@ REDCapR::regex_named_captures(pattern=pattern_boxes, text=choices_1) REDCapR::checkbox_choices(select_choices=choices_1) \dontrun{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token <- "9A81268476645C4E5F03428B8AC3AA7B" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token <- "9A068C425B1341D69E83064A2D273A70" ds_metadata <- redcap_metadata_read(uri, token)$data choices_2 <- ds_metadata[ds_metadata$field_name == "race", ]$select_choices_or_calculations diff --git a/man/redcap_event_instruments.Rd b/man/redcap_event_instruments.Rd index 1afb53d6..63082242 100644 --- a/man/redcap_event_instruments.Rd +++ b/man/redcap_event_instruments.Rd @@ -66,22 +66,22 @@ REDCap API documentation, v.10.5.1) } \examples{ \dontrun{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" # Longitudinal project with one arm -token_1 <- "786334BEB4A87D572DD0E99C4BFCE144" # pid 2629 +token_1 <- "76B4A71A0158BD34C98F10DA72D5F27C" # "arm-single-longitudinal" test project REDCapR::redcap_arm_export(redcap_uri=uri, token=token_1)$data REDCapR::redcap_event_instruments(redcap_uri=uri, token=token_1)$data # Project with two arms -token_2 <- "0434F0E9CF53ED0587847AB6E51DE762" # pid 212 +token_2 <- "DA6F2BB23146BD5A7EA3408C1A44A556" # "longitudinal" test project REDCapR::redcap_arm_export(redcap_uri=uri, token=token_2)$data REDCapR::redcap_event_instruments(redcap_uri=uri, token=token_2)$data REDCapR::redcap_event_instruments(redcap_uri=uri, token=token_2, arms = c("1", "2"))$data REDCapR::redcap_event_instruments(redcap_uri=uri, token=token_2, arms = "2")$data # Classic project (without arms) throws an error -token_3 <- "9A81268476645C4E5F03428B8AC3AA7B" # pid 153 +token_3 <- "9A068C425B1341D69E83064A2D273A70" # "simple" test project REDCapR::redcap_arm_export(redcap_uri=uri, token=token_3)$data # REDCapR::redcap_event_instruments(redcap_uri=uri, token=token_3)$data } diff --git a/man/redcap_next_free_record_name.Rd b/man/redcap_next_free_record_name.Rd index 8d840ac9..c3c1556e 100644 --- a/man/redcap_next_free_record_name.Rd +++ b/man/redcap_next_free_record_name.Rd @@ -77,8 +77,8 @@ record auto-numbering enabled. }\if{html}{\out{}} } \examples{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token <- "9A81268476645C4E5F03428B8AC3AA7B" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token <- "9A068C425B1341D69E83064A2D273A70" # Returns 6 REDCapR::redcap_next_free_record_name(redcap_uri = uri, token = token) } diff --git a/man/redcap_project.Rd b/man/redcap_project.Rd index 14f4ac92..73a87407 100644 --- a/man/redcap_project.Rd +++ b/man/redcap_project.Rd @@ -54,8 +54,8 @@ password for a project. Required.} }} \examples{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token <- "9A81268476645C4E5F03428B8AC3AA7B" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token <- "9A068C425B1341D69E83064A2D273A70" \dontrun{ project <- REDCapR::redcap_project$new(redcap_uri=uri, token=token) ds_all <- project$read() diff --git a/man/redcap_project_info_read.Rd b/man/redcap_project_info_read.Rd index beb0600c..52825870 100644 --- a/man/redcap_project_info_read.Rd +++ b/man/redcap_project_info_read.Rd @@ -101,9 +101,9 @@ separated by a column. Consider using a function like \examples{ \dontrun{ # Specify your project uri and token(s). -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token_simple <- "9A81268476645C4E5F03428B8AC3AA7B" -token_longitudinal <- "0434F0E9CF53ED0587847AB6E51DE762" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token_simple <- "9A068C425B1341D69E83064A2D273A70" +token_longitudinal <- "DA6F2BB23146BD5A7EA3408C1A44A556" # ---- Simple examples REDCapR::redcap_project_info_read(uri, token_simple )$data diff --git a/man/redcap_read.Rd b/man/redcap_read.Rd index 3738f464..2947c649 100644 --- a/man/redcap_read.Rd +++ b/man/redcap_read.Rd @@ -282,8 +282,8 @@ check for invalid event values, and will not throw errors. \examples{ \dontrun{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token <- "9A81268476645C4E5F03428B8AC3AA7B" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token <- "9A068C425B1341D69E83064A2D273A70" # Return the entire dataset REDCapR::redcap_read(batch_size=2, redcap_uri=uri, token=token)$data diff --git a/man/redcap_read_eav_oneshot.Rd b/man/redcap_read_eav_oneshot.Rd index 1ee8ba5a..6caec65a 100644 --- a/man/redcap_read_eav_oneshot.Rd +++ b/man/redcap_read_eav_oneshot.Rd @@ -135,8 +135,8 @@ then this flag will revert to its default value}. } \examples{ \dontrun{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token <- "9A81268476645C4E5F03428B8AC3AA7B" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token <- "9A068C425B1341D69E83064A2D273A70" # Return all records and all variables. ds <- REDCapR:::redcap_read_eav_oneshot(redcap_uri=uri, token=token)$data diff --git a/man/redcap_read_oneshot.Rd b/man/redcap_read_oneshot.Rd index 49153b7b..c38f2f77 100644 --- a/man/redcap_read_oneshot.Rd +++ b/man/redcap_read_oneshot.Rd @@ -199,8 +199,8 @@ throw an error like } \examples{ \dontrun{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token <- "9A81268476645C4E5F03428B8AC3AA7B" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token <- "9A068C425B1341D69E83064A2D273A70" # Return all records and all variables. ds <- REDCapR::redcap_read_oneshot(redcap_uri=uri, token=token)$data diff --git a/man/redcap_read_oneshot_eav.Rd b/man/redcap_read_oneshot_eav.Rd index 786d0b67..020a4448 100644 --- a/man/redcap_read_oneshot_eav.Rd +++ b/man/redcap_read_oneshot_eav.Rd @@ -144,8 +144,8 @@ As of REDCap 6.14.3, this field is not exported in the EAV API call. } \examples{ \dontrun{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token <- "9A81268476645C4E5F03428B8AC3AA7B" +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token <- "9A068C425B1341D69E83064A2D273A70" # Return all records and all variables. ds <- REDCapR:::redcap_read_oneshot_eav(redcap_uri=uri, token=token)$data diff --git a/man/redcap_report.Rd b/man/redcap_report.Rd index b88834e1..e8558cc9 100644 --- a/man/redcap_report.Rd +++ b/man/redcap_report.Rd @@ -92,10 +92,10 @@ Exports the data set of a report created on a project's } \examples{ \dontrun{ -uri <- "https://bbmc.ouhsc.edu/redcap/api/" -token <- "9A81268476645C4E5F03428B8AC3AA7B" -report_1_id <- 5980L -report_2_id <- 6431L +uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/" +token <- "9A068C425B1341D69E83064A2D273A70" +report_1_id <- 12L +report_2_id <- 13L # Return all records and all variables. ds_1a <-