getting help w/ ropensci software
Scott Chamberlain (@sckottie/@ropensci)
UC Berkeley / rOpenSci
scotttalks.info/qropensci
places/ways to get help
read the documentation
always notify us if documentation is not good enough!
help(package = "mongolite")?fxn_name- check if there's any vignettes
- check out ropensci.org/tutorials
open issues in the github repository
should always be a link to the issue tracker on CRAN page for rOpenSci packages
we nudge in right direction w/ issue templates
ask on Stackoverflow
stackoverflow.com/questions/tagged/r
apply [ropensci] tag if applicable
ask on ropensci discussion forum
discuss.ropensci.org
appropriate for technical/non-technical questions, community questions, use cases, etc.
email the maintainer
ideally move to public forum - but exceptions (private data, uncomfortable in public)
email address for maintainer in all rOpenSci & all R packages
twitter!
we're usually quite fast to respond on the twitters
- rOpenSci: @ropensci
- Stefanie: @StefanieButland
- Carl: @cboettig
- Jeroen: @opencpu
- Karthik: @_inundata
- Scott: @sckottie
methods and what they're good for
| method | good for |
|---|---|
| read docs | appropriate every time! |
| github issue | problem specific to a package - bugs/feature reqeusts |
| ask on Stackoverflow | general R questions - see [ropensci] tag |
| ask on ropensci discussion forum | ropensci package specific (technical or not) - & lots of other things |
| email the maintainer | private data - uncomfortable with public forums - otherwise try public |
| must be brief of course (e.g., ask for links to resources) - usually kicks off conversation elsewhere |