Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow use of NCBI API key #12

Open
3 tasks
lakikowolfe opened this issue Mar 29, 2022 · 2 comments
Open
3 tasks

Allow use of NCBI API key #12

lakikowolfe opened this issue Mar 29, 2022 · 2 comments
Assignees
Milestone

Comments

@lakikowolfe
Copy link
Collaborator

lakikowolfe commented Mar 29, 2022

To increase NCBI request rate of 3 requests / second to 10 request /second an API key needs to be created and provided.

  • Have script source entrez key from .Renviron
  • If no entrez key in .Renviron notify user of how to create one, default to sleep time workaround.
  • Add documentation to README about creation of API key

Notes on NCBI API Keys from rentrez tutorial:

By default, the NCBI limits users to making only 3 requests per second (and rentrez enforces that limit). Users who register for an "API key" are able to make up to ten requests per second. Getting one of these keys is simple, you just need to register for "my ncbi" account then click on a button in the account settings page.

Once you have an API key, rentrez will allow you to take advantage of it. For one-off cases, this is as simple as adding the api_key argument to given function call.

If you use rentrez often you should edit your .Renviron file (see r help(Startup) for description of this file) to include your key. Doing so will mean all requests you send will take advantage of your API key.
ENTREZ_KEY=ABCD123

Originally posted by @lakikowolfe in #10 (comment)

@lakikowolfe lakikowolfe self-assigned this Mar 29, 2022
@milen-sage
Copy link
Collaborator

@ychae this is related to pubcrawl+. Not sure if there is a label/milestone for this yet. Not urgent but we may want to revisit in a couple of months.

@ychae
Copy link
Collaborator

ychae commented Jun 20, 2022

@milen-sage Added in a milestone and marked it for mid-August for notification purposes in a couple months.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants