USCbiostats / software-dev

Coding Standards for the USC Biostats group
35 stars 7 forks source link

Package release/update workflow #4

Open malcolmbarrett opened 5 years ago

malcolmbarrett commented 5 years ago

Per a discussion with @pmarjora, perhaps we should formalize the workflow for advertising a package release. What I usually do is:

  1. Write a blog post with a short introduction and links to vignettes etc
  2. Tweet about it. Usually good to include links and images and a few examples of what the package can do (1 to 3 tweets in a thread seems to do well)
  3. Include it in the R Weekly email draft for the next week (to spread out when people see it)

It might be good to use the USCbiostats github pages slot (currently empty) for a blog about package releases and other software announcements from the group. That could also be linked to the R Bloggers network

malcolmbarrett commented 5 years ago

cc @gvegayon @EmilHvitfeldt @zhiiiyang

gvegayon commented 5 years ago

We should probably add it somewhere here: https://github.com/USCbiostats/software-dev/blob/master/templates/r-package.md

zhiiiyang commented 5 years ago

We should probably add it somewhere here: https://github.com/USCbiostats/software-dev/blob/master/templates/r-package.md

My case might not fit into the package submission process since it is probably the only one which goes to Bioconductor.

malcolmbarrett commented 5 years ago

I don't know anything about Bioconductor submissions, but presumably, others will eventually go there, too. Maybe there should be an optional Bioconductor checklist? I don't know if there are any tools to help submission like CRAN though.

zhiiiyang commented 5 years ago

I don't know anything about Bioconductor submissions, but presumably, others will eventually go there, too. Maybe there should be an optional Bioconductor checklist? I don't know if there are any tools to help submission like CRAN though.

They have similar tools as CRAN as well. I will add it to the existing checklist later once I finish submitting it.

malcolmbarrett commented 5 years ago

Ok, I'm going to file this as a separate issue then (#5)

zhiiiyang commented 4 years ago

I pushed a new commit to add download stats and versions for Bioconductor packages in case people didn't notice it https://github.com/USCbiostats/software-dev/commit/a0f830a06268cd9802a113bea5ecb8ae008222b4.

I was planning to use the badger package in the README.RMD instead of hard-coding it. However, it got errors for those packages published after BiocManager's latest version. Hopefully, we can use this package in the future. https://github.com/GuangchuangYu/badger