CRE is an open source package and contributions are welcome from open source community in the form of pull request.Please read the following documents before making changes to the codebase.
Please follow these steps to get a copy of CRE on your Github account.
Fork
button. This will add a
clone of the project to your Github account.@github.com:[your user name]/CRE.git git clone git
Although, in your personal repository, you can pick any branch name, however, in order to keep consistency and also understand who is working on what, the following convention is strongly recommended. In this project, we follow the convention that is proposed by Vincent Driessen in his A successful Git branching model post.
All pull requests should be submitted to
base repository: fasrc/CRE
and base: develop
branch.
devtools::document()
,
devtools::load_all()
after your final modifications.devtools::check()
in RStudio)Please report potential bugs by creating a new issue or sending us an email. Please include the following information in your bug report:
In this project, we follow the tidyverse style guide.
#Acceptable:
<- x + y
z #Not recommended:
<-x+y # (no space)
z<- x+y
z<-x +y z
#Acceptable:
<- matrix(c(1:100), nrow = 5)
a #Not recommended:
<- matrix(c(1:100),nrow = 5) # (no space after comma)
a <- matrix( c(1:100), nrow = 5 ) # (extra space after and before parentheses)
a <-matrix(c(1:100), nrow = 5) # (no space around unary operator <- ) a
#Acceptable:
# This is a comment
#Not recommended:
#This is a comment
# This is a comment (more than one space after #)
## This is a comment (multiple #)
### This is a comment (multiple # and more than one space)
#Acceptable:
<- (z + y)
x #Not recommended:
<- ( z + y ) # (unnecessary space)
x <- (z + y )
x <- ( z + y) x
()
when used with
if
, for
, or while
.#Acceptible
if (x > 2) {
print(x)
}# Not recommended
if(x > 2){
print(x)
}