Document Customer Readers

[KentonWhite]

Report an Issue / Request a Feature

I'm submitting a (Check one with "x") :

• [ ] bug report
• [x] feature request

---

Issue Severity Classification -

(Check one with "x") :

• [ ] 1 - Severe
• [ ] 2 - Moderate
• [x] 3 - Low

Customer Readers are packages that integrate with ProjectTemplate to load a specific file type. I'm aware for a few, like my own for ElasticSearch and one for ShapeFiles. I'd like to add a page to the documentation to describe how to use custom readers, a list of know custom readers, and some short description of how to create a custom reader.

• [ ] Create Custom Reader Page
• [ ] Document how to use a Custom Reader
• [ ] List known Custom Readers
• [ ] Document how to create a Custom Reader
• [ ] Create Vignette

[Hugovdberg]

I'm actually thinking we should add some vignettes to the project. Several of the readers have far too many options and examples for the normal documentation, and I think this would be a nice format to present some other concepts. A nice advantage of vignettes over the website documentation is that the vignettes work offline.

[KentonWhite]

I've never created a Vignette. Do you know how to do that?

[Hugovdberg]

I have been playing a little with them, but until now didn't have the time to create a nice page that's worth uploading ;-) Perhaps I can make a getting started vignette from the website documentation.

[rsangole]

That's a good idea @Hugovdberg . We should certainly create a few vignettes for this package. @KentonWhite I have created them before and they're quite easy to do, following Hadley's instructions at http://r-pkgs.had.co.nz/vignettes.html