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

Migrate to package structure #12

Open
gadenbuie opened this issue Aug 25, 2018 · 6 comments
Open

Migrate to package structure #12

gadenbuie opened this issue Aug 25, 2018 · 6 comments
Assignees
Labels
planning 🌱 Development planning
Milestone

Comments

@gadenbuie
Copy link
Owner

Once the dust settles on the twitter poll...

Rename this repo. It seems that everything will redirect but may need to investigate/resolve if not.

I'd like to merge #10 into a new pkg branch that we can use for the package development. This way we can push fixes and improvements there while leaving the current animations and documentation on the master branch. Once everything is ready to go with the package, we can merge to master.

To facilitate communication, I'd like to still use feature branches and PRs for any major feature additions or updates. Minor bugfixes can be pushed directly to pkg. Branch names like pkg-add-filter-animation are great. Let me know if there are any questions with this workflow.

I'll handle getting #10 into the pkg branch in this repo once it's ready.

@gadenbuie gadenbuie self-assigned this Aug 25, 2018
@gadenbuie gadenbuie added this to the Package v0.1 milestone Aug 25, 2018
@DavZim
Copy link
Collaborator

DavZim commented Aug 25, 2018

Seems like it will be tidyverbs :).
I wonder if its smart to drop "animated" though.
Working on branches and such sounds like a smart idea!

@gadenbuie gadenbuie added the planning 🌱 Development planning label Aug 25, 2018
@gadenbuie
Copy link
Owner Author

I agree... on the other hand, it's hard to think of a what a hypothetical parallel-universe tidyverbs package would do. A verb in the tidyverse should already be in a package with a better more unifying name. So I think I lean towards accepting it as a nice concise package name.

tidyverbs: Animate the Verbs of the Tidyverse.

or

tidyverbs: Verbs of the Tidyverse, Animated.

Regardless, it does seem like there's going to be a clear winner in the poll 😄

gadenbuie added a commit that referenced this issue Aug 27, 2018
- Import packages from tidyverse
- Set global imports in zzzz-package.R
- Import pipe and tidyeval
- Update authors
- Downgrade version to 0.0.1.9000
- Change license to MIT
- TODO: Internal package qualifications still needed, e.g. dplyr::row_numbers()
@DavZim
Copy link
Collaborator

DavZim commented Aug 27, 2018

I really like the tidyexplainer name. But I guess its not really in the poll :)
Do you want to keep pkg open or move the package to master once you have migrated the code?

@gadenbuie
Copy link
Owner Author

I agree, let’s think on it for a day or two.

The name change will happen as soon as it’s settled. The plan with the pkg branch on the other hand is to treat that like the master for the package until the package is solid (more or less feature complete) and then move that branch to master.

@DavZim
Copy link
Collaborator

DavZim commented Aug 30, 2018

One drawback of using tidyverbs is that it comes alphabetically before tidyverse, which results in RStudio suggesting tidyverbs before tidyverse.
Only a minor annoyance though.

@gadenbuie
Copy link
Owner Author

That's a great point and one I hadn't thought of. For me, that convinces me against tidyverbs. It's a minor annoyance, but the tidyverse is a large part of many people's workflows and looking at the auto-complete text it seems we could easily create confusion when bs vs se are the two letters a user has to inspect to differentiate between the two.

image

I think I'm now much more on the side of tidyexplain. It works with the package goals and it's a somewhat "on brand" with my RegExplain package/addin. A tagline could be "Animated explanations of tidyverse verbs."

Btw, here are the other tidy* packages on CRAN as of 2018-08-30:

Tidy CRAN Packages
Package Version second_word first_letter
tidybayes 1.0.1 bayes b
tidyboot 0.1.1 boot b
tidycensus 0.8.1 census c
tidygenomics 0.1.0 genomics g
tidygraph 1.1.0 graph g
tidyhydat 0.3.5 hydat h
tidyimpute 0.1.0 impute i
tidyLPA 0.1.3 LPA L
tidymodels 0.0.1 models m
tidyposterior 0.0.1 posterior p
tidypredict 0.2.0 predict p
tidyquant 0.5.5 quant q
tidyr 0.8.1 r r
tidyRSS 1.2.6 RSS R
tidyselect 0.2.4 select s
tidystats 0.2 stats s
tidystringdist 0.1.2 stringdist s
tidytext 0.1.9 text t
tidytidbits 0.1.0 tidbits t
tidytransit 0.2.3 transit t
tidytree 0.1.9 tree t
tidyverse 1.2.1 verse v
tidyxl 1.0.3 xl x

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

No branches or pull requests

2 participants