Update documentation, remove endpoint not yet served #75
Conversation
* Remove `R/.Rapp.history` macOS history file (https://rdrr.io/r/utils/savehistory.html). * Update `.gitignore` with `usethis` plus manually adding a `.Rapp.history` rule.
R/endpoints.R
Outdated
| #' @param zip optional numeric zip code | ||
| #' @param fips_code optional numeric fips code | ||
| #' @return an instance of epidata_call | ||
| #' @param state A two-letter character string state abbreviation. |
There was a problem hiding this comment.
With fix from #74, maybe this could be a character vector.
There was a problem hiding this comment.
Ditto for probably every instance of "character string" below.
|
Yup, I'll look at it on Monday. |
update documentation for gft, nidss_dengue, nidss_flu, nowcast, fluview, flusurv, ecdc_ili
|
update documentation for gft, nidss_dengue, nidss_flu, nowcast, fluview, flusurv, ecdc_ili Can both of you check if I miss any functions that we want to have documentations on? Would be good if we can nail down those and finished things up. I will then add the auth to all of them. |
|
Also have some questions about the following: |
|
Hm, it occurs to me that we should probably build and host the documentation for this package and integrate CI into it. Would make documentation easier to review. |
|
I have made a number of edits in #77. Many changes across all endpoints.
These shouldn't be blockers for moving ahead with:
It's likely we will need a few more documentation passes, but they will be much smaller in scale. API keys will adjust the documentation somewhat and later we can make small tweaks to individual endpoint docs, rather than making larger passes. Those should be much lighter to manage. |
@keanmingtan I went ahead and made a PR for your changes, as we did some epidatr testing at a tooling meeting off of your branch, and might have comments to add on particular lines (PR is the best place I think). Do you have additional work locally that should be added?