Skip to content

Commit 08f391a

Browse files
committed
docs: rename to save_api_key
1 parent 3018188 commit 08f391a

File tree

4 files changed

+7
-6
lines changed

4 files changed

+7
-6
lines changed

NEWS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# epidatr 1.1.0
2+
23
- renamed the mostly internal `get_auth_key` to `get_api_key`
3-
- added `set_api_key` to more easily set the option
4+
- added `save_api_key` to more easily set the option
45
- various CRAN submission related doc-fixes
56
- fixed some errors from passing "" as a key
67

README.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ API](https://cmu-delphi.github.io/delphi-epidata/). It provides a simple R inter
2828

2929
## Usage
3030

31-
You can find detailed docs here:
31+
You can find detailed docs here:
3232

3333
```{r}
3434
library(epidatr)
@@ -86,7 +86,7 @@ your key, register for a pseudo-anonymous account
8686
[here](https://api.delphi.cmu.edu/epidata/admin/registration_form) and see more
8787
discussion on the [general API
8888
website](https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html). See the
89-
`set_api_key()` function documentation for details on how to use your API key.
89+
`save_api_key()` function documentation for details on how to use your API key.
9090

9191
Note that the private endpoints (i.e. those prefixed with `pvt_`) require a
9292
separate key that needs to be passed as an argument. These endpoints require

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ generate your key, register for a pseudo-anonymous account
115115
[here](https://api.delphi.cmu.edu/epidata/admin/registration_form) and
116116
see more discussion on the [general API
117117
website](https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html).
118-
See the `set_api_key()` function documentation for details on how to use
119-
your API key.
118+
See the `save_api_key()` function documentation for details on how to
119+
use your API key.
120120

121121
Note that the private endpoints (i.e. those prefixed with `pvt_`)
122122
require a separate key that needs to be passed as an argument. These

vignettes/epidatr.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ regions.
2323
We recommend you register for an API key. While most endpoints are available
2424
without one, there are [limits on API usage for anonymous
2525
users](https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html), including
26-
a rate limit. See `set_api_key()` for details on how to obtain an API key and
26+
a rate limit. See `save_api_key()` for details on how to obtain an API key and
2727
set this package to use it.
2828

2929
## Basic Usage

0 commit comments

Comments
 (0)