andreas/REDCapCAST
1
0
Fork 0
mirror of https://github.com/agdamsbo/REDCapCAST.git synced 2026-06-19 13:17:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: new docs

Browse source
This commit is contained in:
Andreas Gammelgaard Damsbo 2026-01-28 22:28:18 +01:00
commit ce6bda19bb
No known key found for this signature in database
6 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

1
man/clean_redcap_name.Rd
View file

@ -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()
}

3
man/create_instrument_meta.Rd
View file

@ -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

2
man/cut_string_length.Rd
View file

@ -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)
}

6
man/strsplitx.Rd
View file

@ -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")
}