website landing page is jank

cmu-delphi / epidatr

Delphi Epidata API R Client

https://cmu-delphi.github.io/epidatr/

Other

1 stars 5 forks source link

website landing page is jank #117

Closed dsweber2 closed 1 year ago

dsweber2 commented 1 year ago

This needs to be updated: https://cmu-delphi.github.io/epidatr/

[x] make a unique landing page for the website that is distinct from the github
[x] documentation link out
[x] both notes to changelog
[x] basic usage example
[x] get started: epidatr is a bit redundant, move the core here and edit the output to include results from a functional api key
[x] codecov badge?

dsweber2 commented 1 year ago

\dontrun results in examples that look like this

if (FALSE) {
fluview_meta() %>% fetch()
}

I would consider this rather jank, but if its the only way to get roxygen to not run the code, then that's that. It would generally be good to have example results in the examples though.ff

dshemetov commented 1 year ago

That does look bad. We could cut those examples from the function documentation and replace them with a link to examples vignette.