From ce6bda19bb6fe37c50dca9745c9d7b52a8058331 Mon Sep 17 00:00:00 2001 From: Andreas Gammelgaard Damsbo Date: Wed, 28 Jan 2026 22:28:18 +0100 Subject: [PATCH] chore: new docs --- DESCRIPTION | 6 ++++-- NEWS.md | 2 ++ man/clean_redcap_name.Rd | 1 + man/create_instrument_meta.Rd | 3 ++- man/cut_string_length.Rd | 2 +- man/strsplitx.Rd | 6 ++++-- 6 files changed, 14 insertions(+), 6 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 0e9f3d9..8a96e13 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -28,11 +28,13 @@ Suggests: rmarkdown, devtools, roxygen2, - spelling + spelling, + jsonlite, + testthat License: GPL (>= 3) Encoding: UTF-8 LazyData: true -RoxygenNote: 7.3.2 +RoxygenNote: 7.3.3 URL: https://github.com/agdamsbo/REDCapCAST, https://agdamsbo.github.io/REDCapCAST/ BugReports: https://github.com/agdamsbo/REDCapCAST/issues Imports: diff --git a/NEWS.md b/NEWS.md index ed136d3..4eacce1 100644 --- a/NEWS.md +++ b/NEWS.md @@ -6,6 +6,8 @@ * FIX: Suggested dependencies were trimmed including {styler}. +* FIX: export_redcap_instrument was updated to include default file name for the instrument zip. Ensures custom names has correct file extension. + # REDCapCAST 25.11.1 * FIX: logicals exported as numeric for data upload diff --git a/man/clean_redcap_name.Rd b/man/clean_redcap_name.Rd index 8040bf7..ac65ba0 100644 --- a/man/clean_redcap_name.Rd +++ b/man/clean_redcap_name.Rd @@ -19,4 +19,5 @@ Trying to make up for different naming conventions. } \examples{ "Research!, ne:ws? and c;l-.ls" |> clean_redcap_name() +"8_new_TEST_" |> clean_redcap_name() } diff --git a/man/create_instrument_meta.Rd b/man/create_instrument_meta.Rd index 742b947..30a6014 100644 --- a/man/create_instrument_meta.Rd +++ b/man/create_instrument_meta.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/export_redcap_instrument.R \name{create_instrument_meta} \alias{create_instrument_meta} -\title{DEPRICATED Create zips file with necessary content based on data set} +\title{DEPRECATED Create zips file with necessary content based on data set} \usage{ create_instrument_meta(data, dir = here::here(""), record.id = TRUE) } @@ -20,6 +20,7 @@ Default is TRUE.} list } \description{ +Use export_redcap_instrument() Metadata can be added by editing the data dictionary of a project in the initial design phase. If you want to later add new instruments, this function can be used to create (an) instrument(s) to add to a project in diff --git a/man/cut_string_length.Rd b/man/cut_string_length.Rd index 0264e20..5b23b47 100644 --- a/man/cut_string_length.Rd +++ b/man/cut_string_length.Rd @@ -18,5 +18,5 @@ character string of length l Cut string to desired length } \examples{ -"length" |> cut_string_length(l=3) +"length" |> cut_string_length(l = 3) } diff --git a/man/strsplitx.Rd b/man/strsplitx.Rd index 464c6a3..9285257 100644 --- a/man/strsplitx.Rd +++ b/man/strsplitx.Rd @@ -25,7 +25,9 @@ Can be used as a substitute of the base function. Main claim to fame is easing the split around the defined delimiter, see example. } \examples{ -test <- c("12 months follow-up", "3 steps", "mRS 6 weeks", -"Counting to 231 now") +test <- c( + "12 months follow-up", "3 steps", "mRS 6 weeks", + "Counting to 231 now" +) strsplitx(test, "[0-9]", type = "around") }