While this package is in development it can be installed directly from GitHub
using the devtools package:
devtools::install_github('nsh87/receptormarker')Once version 1.0 is complete the package will be submitted to CRAN.
Fork the repository and submit changes with a pull request to dev.
To get started, make sure you have the latest version of R and RStudio installed. It is strongly suggested that you have installed the following packages:
install.packages(c("devtools", "roxygen2", "testthat", "knitr"))
devtools::install_github('jimhester/lintr') # Do not install from CRANLoad receptormarker.Rproj to open the project in RStudio, then load the code:
devtools::load_all()Be sure to follow this code style
and document your functions. If you create any functions that are internal and not of
interest to most users, be sure to document them with @keywords internal to
exclude them from the package index. You should explicitly
define functions to export
to NAMESPACE with Roxygen2's @external tag. Build .Rd files from Roxygen2 comments with:
devtools::document()It is strongly suggested that you automate testing of all functions written. Run all tests with:
devtools::test()Before submitting a pull request you should build the documentation, run tests, and check that the package builds. This can be done with a single command:
devtools::check()