search

ropensci-archive / crminer

:no_entry: ARCHIVED :no_entry: Fetch 'Scholary' Full Text from 'Crossref'
Other
17 stars 5 forks source link

Add a vignette #23

Closed sckott closed 4 years ago

sckott commented 7 years ago

This package needs more documentation! Help out the community by contributing a vignette. If you don't know what a vignette is, check out http://r-pkgs.had.co.nz/vignettes.html for an introduction.

If you aren't sure how to contribute on github checkout https://github.com/ropensci/crminer/blob/master/.github/CONTRIBUTING.md

Keep in mind our code of conduct https://github.com/ropensci/crminer/blob/master/CONDUCT.md

zaynaib commented 6 years ago

Hello, I would like to help out on this issue. I am a r beginner but I do know Markdown very well. Thanks, Ola

sckott commented 6 years ago

Thanks for your interest @zaynaib - Follow tips here on how to make a vignette http://r-pkgs.had.co.nz/vignettes.html

I've just pushed a blank file to make the vignette in: https://github.com/ropensci/crminer/blob/master/inst/vign/crminer-vignette.Rmd

let me know if you have any questions.

This package may be a bit frustrating to run all examples in as some articles that functions in this package request require you to have access, typically through a university. But some examples will work if they request an article from an open access publisher.