search

gaynorr / AlphaSimR

R package for breeding program simulations
https://gaynorr.github.io/AlphaSimR/
Other
40 stars 17 forks source link

Multipop #143

Closed philipbg closed 1 year ago

philipbg commented 1 year ago

Changed "MegaPop" to "MultiPop" as mentioned here: https://github.com/gaynorr/AlphaSimR/issues/120#issuecomment-1609886575

gregorgorjanc commented 1 year ago

@philipbg @gaynorr looks ok - most changes are whitespace

@philipbg it would be good to mention this name change in the NEWS (or equivalent) file - I don't think anyone/many use this option at this stage, but good to document the change.

philipbg commented 1 year ago

@gregorgorjanc I am not sure why so much whitespace changes came about. I didn't hit space or enter. I just did find and replace. It looks like NEWs is updated with new versions of ASR, so this change (along with others) might be documented when a new version is released? Is there a place to put new changes that haven't been packaged into a new version yet?

gregorgorjanc commented 1 year ago

@philipbg whitespace changes likely came from RStudio defaults. I have the same settings;)

@philipbg NEWS file can be updated as we go along so that on the release you have it mostly done;)

philipbg commented 1 year ago

@gregorgorjanc it must be a default for emacs/magit too then

gaynorr commented 1 year ago

@philipbg The initial checks failed due to the Namespace file not reflecting the changes you made. I fixed this by deleting the Namespace file and reran roxygen2::roxygenize() to auto generate it again.

I typically run "clean and install" in the "build" tab of RStudio before submitting a branch. This should update the documentation and Namespace file. It also serves as a check that everything is working by running running the unit tests and examples. Note that I have the "Generate documentation with Roxygen" box ticked in the "Configure build tools" menu.

I do find that sometimes the Namespace and documentation doesn't get updated like it should. This usually results an error when running "Build". I suspect this issue comes from working on different computers with different RStudio options, but I haven't isolated the exact cause. The delete the Namespace file trick I used above usually resolves this.