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

make this repo an R package #6

Open
5 of 7 tasks
raynamharris opened this issue Apr 3, 2019 · 4 comments
Open
5 of 7 tasks

make this repo an R package #6

raynamharris opened this issue Apr 3, 2019 · 4 comments

Comments

@raynamharris
Copy link
Member

raynamharris commented Apr 3, 2019

I found some documentation on best practices for GitHub repos and R packages (mainly this one https://github.com/ropensci/rrrpkg and this one https://kbroman.org/pkg_primer/)

So, I decided to make this repo a package. This reuired a few changes:

  • rename my scripts directory to analysis (commits b39ef4e and 851efb7)
  • adding a DESCRIPTION file (commit dcefb56)
  • reneme this repo from dove_parents_RNAseq to DoveParentsRNAseq because titles can't have underscores (commit cb3e6ac)

It works! Other people should be able to use install_github("macmanes-lab/DoveParentsRNAseq") to load the data and function (once it's not private).

still need to

  • move functions out of analsis and into a new directory R
  • add a man directory with documentatoin
  • add a NAMESPACE file
  • make repo public
@raynamharris
Copy link
Member Author

raynamharris commented Apr 3, 2019

moved printplotcontrasts function and added documentation in commit 7e56177

@raynamharris
Copy link
Member Author

Note: it's nice to use cache=TRUE when experimenting with the data anlysis pipeline, but these cache files must be deleted before packing the repo

@raynamharris
Copy link
Member Author

added namespace with commit 40a5015

@raynamharris
Copy link
Member Author

and here's the one-liner to make a SummarizedExperiment for easy loading of data
https://bioconductor.org/packages/release/bioc/vignettes/SummarizedExperiment/inst/doc/SummarizedExperiment.html

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

1 participant