- For all proposed changes, fork the repository, and then issue a pull request that will be reviewed.
- Merge external pull requests in the
develop
branch of the repository, rather thanmaster
, if possible. - Pull requests must pass build checks on Travis CI.
- Support is only provided for the current release version.
Package style syntax
Attempt to follow these style guides, by priority:
Please adhere to these guidelines, in particular:
- Object and function parameter arguments should be formated in lowerCamelCase.
- Use spaces instead of tabs. Indent with 4 spaces.
- Use
<-
and not=
for assignment. - Explicitly define
if
/then
statements using opening and closing brackets ({
,}
). -
else
declarations should be on the same line as the closing bracket. - Use spaces around assignment operators (
<-
), brackets ({
), and comma delimiters (e.g.c("foo", "bar")
notc("foo","bar")
.
Required checks
Run these commands prior to a pull request:
devtools::document()
devtools::run_examples()
devtools::test()
devtools::check()
BiocCheck::BiocCheck(getwd())
lintr::lint_package()
covr::report()
Rebuild website
unlink("docs", recursive = TRUE)
pkgdown::build_site()