README.md

In SwissClinicalTrialOrganisation/DM_secuTrial_R: Handling of secuTrial related data

This repository is no longer used and can likely be removed in the long run.

This is the original repository for the secuTrial R package. We have since restarted implementation of the package which is now here: https://github.com/SwissClinicalTrialOrganisation/secuTrialR

The secuTrial R library

Installing with devtools

# if you do not have devtools installed
install.packages("devtools", dependencies=TRUE)
# install secuTrail R library
devtools::install_github("SwissClinicalTrialOrganisation/DM_secuTrial_R")
# load secuTrail R library
library(secuTrial)

Testing and running examples with devtools

# assuming that your R session's working directory is DM_secuTrial_R
# alternatively you can supply the fullpath to the package directory
devtools::test(".")
devtools::run_examples(".")
devtools::spell_check()
# use lintr on file in the R directory that you have edited
# example
lint("analysis.R", line_length_linter(125))

Guidelines for contributers

In order to contribute to this R library you should fork the main repository, make your changes and send a pull request (PR). The PR should also have a description to help the reviewer understand what has been added/changed. New functionalities must be thoroughly documented, have examples and should be accompanied by at least one test in test-secuTrial.R to ensure longterm robustness. The PR will only be reviewed if all travis checks are successful. The person sending the PR should not be the one merging it.

SwissClinicalTrialOrganisation/DM_secuTrial_R documentation built on May 21, 2019, 10:16 a.m.