Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review of February 2020 development #1

Open
12 tasks done
arni-magnusson opened this issue Feb 24, 2020 · 8 comments
Open
12 tasks done

Review of February 2020 development #1

arni-magnusson opened this issue Feb 24, 2020 · 8 comments

Comments

@arni-magnusson
Copy link
Member

arni-magnusson commented Feb 24, 2020

Hi Greg,

Below is a summary of my 39 commits in February, for your review. Some are clear improvements (tag CRAN releases, fix typos, add bubbleplot) while others were perhaps not quite as necessary, but still improvements I hope (comb through Rd files to standardize format, etc.).

  • 8e3c49f CRAN version 3.0.1.1.
  • 6293b7c CRAN version 3.0.1.2.
  • 14adbe7 Merge CRAN and warnes/r-gregmisc/gplots
  • cb708e2, 6fc42c0, e1459d4 Link to online Balloon Plot paper, rather than including PDF inside inst folder.
  • 8ffdc83 Consistent indentation and format of balloonplot.R code.
  • 3f7df9d, e1459d4 List of functions is now in ?gplots, same as help("gplots-package"), as well as on the front page readme. Once on CRAN, we can link from the readme to the online help page, so we maintain list in one place.
  • 60d0201 Alternative format for NEWS file, so news(package="gplots") now displays as HTML in a browser.
  • 882d317, 1374128, 32b6749, 73b9a5b, 29e1bcf, d3401ee, 1aa09ff, 20ca6fd, 3d9b121, 1d4a3dd, 885f083 Many small improvements in Rd files, consistent style similar to core R.
  • 3612a18 Consistent indentation and format of heatmap.2.R code.
  • e8b85d9 Add bubbleplot.
  • 53b972c Remove header comments.
  • ed28596 Remove gdata dependency. gplots now depends on gtools, caTools, and bitops.

In general, I resisted the temptation to edit *.R files, except whitespace and comments in balloonplot.R and heatmap.2.R. My main effort was to make small improvements to the help pages, both from the user and maintainer perspective. I don't feel strongly about any of these commits, so feel free to make any additional commits that revert some of those changes.

As far as I'm concerned, the package is ready for a 3.1.0 CRAN release, to remove the orphaned status. My future edits to gplots will be much smaller and easier to review. I hope this 'spring cleaning' is well received :)

@warnes
Copy link
Member

warnes commented Feb 25, 2020

FWIW, I would be happy to see gplots converted to use ROxygen instead of .Rd files. Perhaps using https://yihui.org/rd2roxygen...

@arni-magnusson
Copy link
Member Author

Thanks for the thorough ongoing review, Greg. Lots of good points that I agree with.

I'll do the edits on bubbleplot and you can edit everything else directly. No need for me to review your review :)

@warnes
Copy link
Member

warnes commented Feb 25, 2020

I've finished my review.

Thank you for all of the hard work!!!

Would you mind doing the edits? I've used up (more than) the time alotted...

@arni-magnusson
Copy link
Member Author

No problem, will do!

@arni-magnusson
Copy link
Member Author

List of remaining discussion points:

@arni-magnusson
Copy link
Member Author

Hi Greg, I've processed your review. Thanks for the dedication to go through all of the February commits!

You found several changes of mine that were not that great, but instead of reverting them you came up with even better solutions. What remains is a much improved package: a new function, fewer package dependencies, a package help page, and tidier help pages with a consistent (base R) style.

If you git checkout master, git merge arni and git push, I will probably just delete the arni branch. I can create a new feature branch in the future, if I want to make a specific suggestion.

I think we can also git checkout develop, git merge master and git push to fast-forward develop to catch up with master. Then all branches would be even, ready for Tal's additions. Should we make the master branch the default branch?

P.S. The 60d0201#r37492486 question is still pending.

@warnes
Copy link
Member

warnes commented Mar 5, 2020

Hi Arni,

The normal way to handle changes is to make them on a branch, then create a pull request (PR), which provides a clean mechanism for reviewing and commenting on the changes. See the official docs here.

When the PR is merged, it includes an option to delete the old branch.

Can you create a PR for the arni branch? I'll then do a final review and approve, after which any of use can do the merge.

I really appreciate all of your hard work!

-G

@arni-magnusson
Copy link
Member Author

I agree, pull requests are the way to go. I have now created pull request #5 and issue #6. We can either close issue #1 now, or when these have been resolved:
#5 (Pull Request) Revisions from February 2020 development review
#6 (Issue) Update list of authors/contributors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants