Skip to content

Commit e02a88b

Browse files
authored
Update OpenAlex Recipe and Standardize Rate Limit Blurbs (#177)
* docs: Fix typo in CONTRIBUTING.md * docs: Add Rmd button to R template * docs: Change blurb on API rate limits * fix: Update OpenAlex recipe * feat: Add button styling to download button on Cite page
1 parent f9c9e09 commit e02a88b

64 files changed

Lines changed: 384 additions & 1825 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ All contributions are reviewed for accuracy, clarity, reproducibility, and consi
4040

4141
## Project Scope
4242

43-
As of 2025, the Cookbook focuses on maintaining and standardizing Python and R tutorials. Other language have been archived and are no longer actively maintained.
43+
As of 2025, the Cookbook focuses on maintaining Python and R tutorials. Other languages have been archived and are no longer actively maintained.
4444

4545
### Project Infrastructure
4646

recipe-templates/python.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"<!-- Also include links to any licenses, official code examples, and other useful sources above. -->\n",
2828
"<!-- If you are using any specific libraries for accessing the API, include terms of use, documentation, etc. for those as well. -->\n",
2929
"\n",
30-
"**_NOTE:_** The [API Name] limits requests to a maximum of [limit].\n",
30+
"**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.\n",
3131
"\n",
3232
"*These recipe examples were tested on [Month] [Date], [Year].*"
3333
]

recipe-templates/r.Rmd

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
By [Author Name], [Author Name], and [Author Name]
1717

18+
<div class="rmd-btn-wrapper">
19+
<a class="rmd-btn"
20+
href="https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook/blob/main/rmarkdown/[ADD API NAME HERE].Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
<!-- Brief 1-2 sentence description of the API -->
1928

2029
<!-- *This tutorial content is intended to help facilitate academic research. Please check your institution for their Text and Data Mining or related License Agreement with [Company name].* -->
@@ -34,7 +43,7 @@ Please see the following resources for more information on API usage:
3443
<!-- Also include links to any licenses, official code examples, and other useful sources above. -->
3544
<!-- If you are using any specific libraries for accessing the API, include terms of use, documentation, etc. for those as well. -->
3645

37-
_**NOTE:**_ The [API Name] limits requests to a maximum of [limit].
46+
**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.
3847

3948
*These recipe examples were tested on [Month] [Date], [Year].*
4049

rmarkdown/arxiv.Rmd

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,12 @@ Please see the following resources for more information on API usage:
3737
- Data Reuse
3838
- <a href="https://info.arxiv.org/help/license/reuse.html" target="_blank">arXiv Permissions and Reuse</a>
3939

40-
*Acknowledgment: Thank you to arXiv for use of its open access interoperability.*
40+
**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.
4141

4242
*These recipe examples were tested on March 23, 2026.*
4343

44+
*Acknowledgment: Thank you to arXiv for use of its open access interoperability.*
45+
4446
## Setup
4547

4648
The following packages need to be installed into your environment to run the code examples in this tutorial. These packages can be installed with `install.packages()`.

rmarkdown/casc.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Please see the following resources for more information on API usage:
3737
- Data Reuse
3838
- CAS Common Chemistry is provided under the <a href="https://creativecommons.org/licenses/by-nc/4.0/" target="_blank">Creative Commons CC BY-NC 4.0 license</a>
3939

40+
**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.
41+
4042
*These recipe examples were tested on March 24, 2026.*
4143

4244
## Setup

rmarkdown/chronam.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Please see the following resources for more information on API usage:
3838
- <a href="https://www.loc.gov/legal/" target="_blank">Library of Congress Legal Notice</a>
3939
- <a href="https://www.loc.gov/collections/chronicling-america/about-this-collection/rights-and-access/" target="_blank">Library of Congress Rights and Access</a>
4040

41+
**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.
42+
4143
*These recipe examples were tested on March 23, 2026.*
4244

4345
> **Attribution:** We thank ***Professor Jessica Robertson*** (UA Libraries, Hoole Special Collections) for helpful discussions. All data was collected from the Library of Congress, Chronicling America: Historic American Newspapers site, using the API.

rmarkdown/college-scorecard.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Please see the following resources for more information on API usage:
3434
- <a href="https://www.ed.gov/about/ed-overview/required-notices/website-policies/copyright-status-notice-us-department-of-education" target="_blank">College Scorecard Copyright Status</a>
3535
- <a href="https://data.gov/privacy-policy/" target="_blank">Data\.gov Privacy Policy</a>
3636

37-
**_NOTE:_** The College Scorecard API limits requests to a maximum of 1000 requests per IP address per hour.
37+
**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.
3838

3939
*These recipe examples were tested on March 23, 2026.*
4040

rmarkdown/crossref.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Please see the following resources for more information on API usage:
4040
- <a href="https://www.crossref.org/documentation/retrieve-metadata/rest-api/rest-api-metadata-license-information/" target="_blank">Crossref Metadata Reuse</a>
4141
- <a href="https://www.crossref.org/documentation/retrieve-metadata/rest-api/providing-licensing-information-to-tdm-tools/" target="_blank">Crossref TDM Licensing</a>
4242

43-
**_NOTE:_** The <a href="https://api.crossref.org/swagger-ui/index.html" target="_blank">Crossref API</a> limits requests to a maximum of 50 per second.
43+
**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.
4444

4545
*These recipe examples were tested on March 23, 2026.*
4646

rmarkdown/pubchem.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Please see the following resources for more information on API usage:
3535
- Data Reuse
3636
- <a href="https://www.ncbi.nlm.nih.gov/home/about/policies/" target="_blank">NCBI Copyright Information</a>
3737

38-
_**NOTE:**_ The PubChem limits requests to a maximum of 5 requests per second.
38+
**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.
3939

4040
*These recipe examples were tested on March 24, 2026.*
4141

rmarkdown/pubmed.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Please see the following resources for more information on API usage:
3636
- Data Reuse
3737
- <a href="https://www.ncbi.nlm.nih.gov/home/about/policies/" target="_blank">NCBI Data Reuse Policy</a>
3838

39-
_**NOTE:**_ The PubMed API (Entrez E-utilities) limits requests to a maximum of 3 requests per second without an API key, and up to 10 requests per second with an API key.
39+
**_NOTE:_** Please see access details and rate limit requests for this API in the official documentation.
4040

4141
*These recipe examples were tested on March 24, 2026.*
4242

0 commit comments

Comments
 (0)