Conte-Ecology / conteStreamTemperature

Package for cleaning and analyzing stream daily stream temperature
MIT License
1 stars 1 forks source link

Manually editing roxygen2 generated files #10

Closed Tom-Bombadil closed 10 years ago

Tom-Bombadil commented 10 years ago

So the NAMESPACE file has a conflict in it form trying to merge automatically. Is it ok to manually delete this and update it? I'm not sure what the protocol is for the files that say "do not edit by hand".

Dan, can you remind me of the location of the wiki you have that explains package building and loading etc. I'm working through it all but am still getting some errors. I think something similar to the "Walkthrough" on forking etc you made would be very helpful for this process if this doesn't already exist.

djhocking commented 10 years ago

Hmm, is it the only place where a merge conflict exists? Presumably there is a conflict in the documentation of a function or in the package description that is causing the conflict in NAMESPACE. I'm not sure what to do. I'll look into it. It might be possible to delete the NAMESPACE file (just move to somewhere else), correct any other conflicts, then merge and rebuild, thereby recreating the NAMESPACE. This isn't good version control practice, but if it works that would be fine. I'd definitely back up everything first. Jeff might actually know how to handle this properly.

I haven't had the time to put together the package walk through but we have tips and links in the conte-ecology home repo wiki: https://github.com/Conte-Ecology/home/wiki/R-Packages

djhocking commented 10 years ago

Okay, I asked around on Twitter and Hadley responded (TGIH: Thank God for Hadley). Delete/fix any conflicts outside of NAMESPACE then in the RStudio Console run devools:::document(). This will rebuild the package including the NAMESPACE. Then in Bash do git add . git commit -m "fixed merge conflict blah, blah, blah" git push origin master

Tom-Bombadil commented 10 years ago

Ok sounds good, thanks. The conflicts should be taken care of but I will check to be certain and then rebuild.

Thanks for the tips, I couldn't remember where they were.

walkerjeffd commented 10 years ago

oh dang, i was just writing the same answer as hadley!

devtools::document() will rebuild NAMESPACE

On Fri, Sep 5, 2014 at 2:56 PM, Daniel J. Hocking notifications@github.com wrote:

Okay, I asked around on Twitter and Hadley responded (TGIH: Thank God for Hadley). Delete/fix any conflicts outside of NAMESPACE then in the RStudio Console run devools:::document(). This will rebuild the package including the NAMESPACE. Then in Bash do git add . git commit -m "fixed merge conflict blah, blah, blah" git push origin master

— Reply to this email directly or view it on GitHub https://github.com/Conte-Ecology/conteStreamTemperature/issues/10#issuecomment-54666622 .