olshena / COVIDNearTerm

1 stars 0 forks source link

Instructions on how to update #4

Closed olshena closed 4 years ago

olshena commented 4 years ago

Please include instructions on how to update the package so any member of the team can make updates.

kikapp commented 4 years ago

To update, one would clone the repo locally, make desired changes, then push the changes back to the repo. Should I put this in the readme?

olshena commented 4 years ago

I know generically how to update a repo. I thought since this repo included an R package there might be extra steps if I updated the R code. If not then we can close.

kikapp commented 4 years ago

On further thought, it depends on how the code is changed. If new functions are added or function arguments are changed, then before the project code gets pushed to github, you'd need to navigate to the the project's local directory and run roxygenize() from the roxygen2 package. This will regenerate the DESCRIPTION, NAMESPACE and /man file/folder to reflect the updates.