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

Convert hexwall into a package? #1

Closed
pkq opened this issue Jun 1, 2018 · 5 comments
Closed

Convert hexwall into a package? #1

pkq opened this issue Jun 1, 2018 · 5 comments

Comments

@pkq
Copy link

pkq commented Jun 1, 2018

I've been mulling the idea of something similar for a few weeks now, so thanks for putting this together! Have you considered turning this into a proper package? Even with just the one function, I think it'd be worthwhile, and could be done pretty easily with usethis (and friends). Would you be interested in a PR to that effect?

@mitchelloharawild
Copy link
Owner

I have considered making it a package (the code is written in a way to make a package from it trivially), however I do not see the need for a package yet.

I was first planning to make it a gist, however using a repo allows me to describe the function with the README, and help users try the function for themselves. As it is simple to setup the function already, I actually think a single-function package is harder for users to setup.

In-fact, the current usage guide could be simplified to running

source("https://raw.githubusercontent.com/mitchelloharawild/hexwall/master/hexwall.R")

Except I wanted to discourage this because sourcing files directly from the web can be dangerous.

If the script had more functionality, I can see this being developed into an R package. For example, if a repository was constructed to organise and store R-specific hexagon stickers (similar to https://github.com/maxogden/hexbin), this package could provide tools to access and combine them.

@pkq
Copy link
Author

pkq commented Jun 1, 2018

Fair enough. I definitely appreciate the README and that you're not encouraging users to source directly from the web, even though I'm pretty all-in on the idea of packages as "the fundamental units of reproducible R code" as Hadley would say. An R-specific hex sticker repository would be slick! I've long wished there were more R hex stickers on hexbin. At any rate, thanks much for sharing the code!

@pkq
Copy link
Author

pkq commented Jun 1, 2018

Out of curiosity, do you have any thoughts about the best way to go about creating an R-specific hex sticker repository?

@mitchelloharawild
Copy link
Owner

I think hexbin does it very well, so the best way would probably be to start from their repo.

I would like the meta information to be slightly more informative, to allow for package names, distinguishing between CRAN/Bioconductor/GitHub/Other packages... It would also be nice to store keywords and other information (similar to https://github.com/ggplot2-exts/gallery).

@pkq
Copy link
Author

pkq commented Jun 7, 2018

Agreed on both counts. Coincidentally, I was just granted collaborator access to hexbin, so I can actually get stickers merged (including you pride sticker 😄), if you know anyone who's been holding off on submitting there given the limited activity in recent months.

I also posted an issue with some initial ideas for additional metadata fields to hexbin itself. Would be great to get your thoughts there, if you're interested. I'm guessing that any changes would be more limited in scope than what the ggplot2 extensions gallery has, but I think it's worth a conversation before getting too far on anything R specific.

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