minor edits

This commit is contained in:
Andreas Gammelgaard Damsbo 2024-11-15 20:54:37 +01:00
parent a02f96828e
commit d8d11f6da1
No known key found for this signature in database
3 changed files with 4 additions and 448 deletions

View File

@ -18,18 +18,6 @@ shiny_cast <- function(...) {
}
shiny::runApp(appDir = appDir, ...)
# This is from the VarSelLCM
# shiny_cast2 <- function(X){
# check.results(X)
# G <- .GlobalEnv
# assign("resVSLC", X, envir=G)
# a=shiny::runApp(system.file(package="REDCapCAST"),launch.browser = TRUE)
# return(invisible(a))
# }
# shiny::runApp(appDir = here::here("app/"),...)
# ## Need adjustments to run anywhere
}

File diff suppressed because one or more lines are too long

View File

@ -16,8 +16,6 @@ The functions of this app can be described in two parts:
2. upload the created database file and data to a given REDCap server via API access.
Below, each step is described in more details.
## Getting started
On the left, you initially just find one single option to upload a spreadsheet. Having done this, you can then preview the uploaded data and generated data dictionary by selecting the relevant tab on the top right.
@ -30,7 +28,7 @@ Based on the uploaded spreadsheet, the app will make a qualified guess on data c
If you want to add data to an existing database, an instrument can be created. This metadata file is identical to a data dictionary, but does not include a "record_id" field and is packaged as a .zip file, which is uploaded in the "Designer" interface in REDCap.
### Transferring directly to REDCap database
### Transferring directly to a REDCap database
Based on the API-functions in REDCap, you can upload your data dictionary and renamed data directly from this interface (no data is stored on the server, but consider launching this shiny app on your own machine after having installed the [REDCapCAST package](https://agdamsbo.github.io/REDCapCAST/#installation) in R). Launch a local instance of this app with:
@ -38,6 +36,8 @@ Based on the API-functions in REDCap, you can upload your data dictionary and re
REDCapCAST::shiny_cast()
```
Please mind you, that uploading a new data dictionary can delete data in your database and is non-reversible. Make sure to save a backup beforehand. Also, uploading a data dictionary to a server in production is not possible. This step is only advisable for newly created databases. See the "Disclaimer" above.
## Background
The main structure of variables of a REDCap database is defined by a so-called data dictionary. This is a simple spreadsheet file defining one or more instruments, data classes, branching logic and more. It does not contain any information on randomization, longitudinal data or repeatable instruments. These functions must be set up in the REDCap interface after having defined the data dictionary.
@ -58,7 +58,7 @@ This app and package can be cited using the following bibtex citation or by refe
@Manual{,
title = {REDCapCAST: REDCap Castellated Data Handling And Metadata Casting},
author = {Andreas Gammelgaard Damsbo and Paul Egeler},
year = {2016},
year = {2024},
note = {R package version 24.11.1, https://agdamsbo.github.io/REDCapCAST/},
url = {https://github.com/agdamsbo/REDCapCAST},
}