README.md

ProtocolGenerator

Introduction

Create HTML protocol document using the Strategus json specification

Examples

# install dependencies
remotes::install_github('ohdsi/ProtocolGenerator')

library(ProtocolGenerator)

# to run the protocol generator with a demo json specification
test <- generateProtocol(
  jsonLocation = getDemoLoc(),
  webAPI = 'https://api.ohdsi.org/WebAPI',
  outputLocation = './protocol'
)

# to run with your own json spec 
test <- generateProtocol(
  jsonLocation = '<insert location to json specification file>',
  webAPI = 'https://api.ohdsi.org/WebAPI',
  outputLocation = './protocol'
)

Technology

ProtocolGenerator is an R package.

System Requirements

Running the package requires R.

Installation

1. In R, use the following commands to download and install ProtocolGenerator:

install.packages("remotes")
remotes::install_github("ohdsi/ProtocolGenerator")

User Documentation

Documentation can be found on the package website.

Support

• Developer questions/comments/feedback: OHDSI Forum
• We use the GitHub issue tracker for all bugs/issues/enhancements

Contributing

Read here how you can contribute to this package.

License

ProtocolGenerator is licensed under Apache License 2.0.

Development

ProtocolGenerator is being developed in R Studio.

Development status

Under development

Acknowledgements