search

ATFutures / geoplumber

Serve geographic data from R and consume with scalable front end.
https://atfutures.github.io/geoplumber/
59 stars 7 forks source link

Write vignette #24

Closed mpadge closed 5 years ago

mpadge commented 6 years ago

If it's okay, I'd like to self-nominate this one, because it seems the best way for me to get a sufficiently deep grasp of this amazing work. Plus, having an outsider write a vignette is very often the best way! :smile:

layik commented 6 years ago

Thank you @mpadge that is awesome.

Robinlovelace commented 6 years ago

Suggestion: put it all in the README for now and then split-out the vignetty content once it's out there and tested and the use cases and commonly asked questions become clearer. Well up for helping with this also++

layik commented 6 years ago

I do need to get my R/package commenting/documenting up to a much higher standard.

Robinlovelace commented 6 years ago

@mpadge is a vignette pro. Will look amazing. +1 to getting placeholders up there btw.

layik commented 6 years ago

If you write a nice vignette, consider submitting it to the Journal of Statistical Software or The R Journal. Both journals are electronic only and peer-reviewed. Comments from reviewers can be very helpful for improving the quality of your vignette and the related software.

http://r-pkgs.had.co.nz/vignettes.html

layik commented 5 years ago

Should be next, now that we have few use cases to present. Also to get it ready for CRAN.

mpadge commented 5 years ago

And I'm still self-nominated in spite of my not having done anything yet. But with @silberzwiebel now cracking on this, our joint use case for moveability will be sufficient motivation for me to do this. If I don't find time tomorrow, I promise I'll be on to it by next week.

Robinlovelace commented 5 years ago

One option @layik is to move parts of the gisruk abstract (especially the schematic diagram) into a skeleton vignette.

layik commented 5 years ago

Thanks @mpadge. Agree @Robinlovelace, hopefully Mark/Thomas will kindly remove it from the README.

layik commented 5 years ago

Will be putting in the GISRUK paper into the vignette.

layik commented 5 years ago

Written.