Skip to content

Commit

Permalink
Clarify what npi_is_valid() does per #22 and how to cite the package
Browse files Browse the repository at this point in the history
  • Loading branch information
frankfarach committed Feb 28, 2022
1 parent 10eae04 commit a00f1f3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ Use `npi_is_valid()` to check whether each element of a vector of candidate numb
npi_is_valid(c(1234567893, 1234567898))
```

This function doesn't check whether the NPI numbers are activated or deactivated (see https://github.com/frankfarach/npi/issues/22#issuecomment-787642817).

## Set your own user agent

By default, all request headers include a user agent that references this repository. You can customize the user agent by setting the `npi_user_agent` option:
Expand All @@ -128,6 +130,10 @@ Please note that this project is released with a [Contributor Code of Conduct](C

Interested in learning how you can contribute to npi? Head over to the [contributor guide](CONTRIBUTING.md)—and thanks for considering!

## How to cite this package

For the latest citation, see the [Authors and Citation](https://frankfarach.github.io/npi/authors.html#citation) page on the package website.

## License

MIT (c) [Frank Farach](https://github.com/frankfarach)
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,10 @@ npi_is_valid(c(1234567893, 1234567898))
#> [1] TRUE
```

This function doesn’t check whether the NPI numbers are activated or
deactivated (see
<https://github.com/frankfarach/npi/issues/22#issuecomment-787642817>).

## Set your own user agent

By default, all request headers include a user agent that references
Expand Down Expand Up @@ -231,6 +235,12 @@ to abide by its terms.
Interested in learning how you can contribute to npi? Head over to the
[contributor guide](CONTRIBUTING.md)—and thanks for considering!

## How to cite this package

For the latest citation, see the [Authors and
Citation](https://frankfarach.github.io/npi/authors.html#citation) page
on the package website.

## License

MIT (c) [Frank Farach](https://github.com/frankfarach)

0 comments on commit a00f1f3

Please sign in to comment.