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

structure of vignettes / new vignettes #45

Open
sa-lee opened this issue Jul 29, 2018 · 0 comments
Open

structure of vignettes / new vignettes #45

sa-lee opened this issue Jul 29, 2018 · 0 comments

Comments

@sa-lee
Copy link
Collaborator

sa-lee commented Jul 29, 2018

We have some good material now for actually using plyranges thanks to the BiocWorkshops which should be linked in both the README and also the intro vignette.

In my opinion, the intro vignette should not reference how things are done / comparisons to GenomicRanges API. That could be split out into a small vignette for users that are actually interested in those details.

Since the overlaps ideas seem to be a point of pain for all users, I think more concrete examples are needed here in a separate vignette. I think we could use the pasillaBamSubset to incorporate the more specialised BAM reading functionality along with this.

So structure would be:

  1. introduction (include link to workshops) (this I think of as plyranges for users of tidyverse)
  2. plyranges for users of GenomicRanges
  3. overlaps

We are introducing two new (short) vignettes, plus a more concrete introduction

@sa-lee sa-lee added this to To do in plyranges 1.4.0 Jul 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

No branches or pull requests

1 participant