Skip to content

Commit f9c9e09

Browse files
authored
Merge pull request #176 from UA-Libraries-Research-Data-Services/add-rmd-button
Add RMarkdown button to R tutorials
2 parents 77433fc + 5b25ca8 commit f9c9e09

35 files changed

Lines changed: 284 additions & 11 deletions

rmarkdown/arxiv.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
by Adam M. Nguyen and Michael T. Moen
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/arxiv.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
Hosted and maintained by Cornell University, arXiv is an open-access and free distribution service containing nearly 2.5 million scholarly articles in fields including physics, mathematics, computer science, quantitative biology, quantitative finance, statistics, electrical engineering and systems science and economics at the time of writing. In this tutorial we will introduce how to use the API with some examples, but for larger bulk downloads of data from arXiv, we recommend <a href="https://www.kaggle.com/datasets/Cornell-University/arxiv/data" target="_blank">Kaggle's arXiv Dataset</a>, which is updated monthly with the full arXiv data set and metadata.
1928

2029
Please see the following resources for more information on API usage:

rmarkdown/casc.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@ knitr::opts_chunk$set(
1616

1717
by Adam M. Nguyen and Michael T. Moen
1818

19+
<div class="rmd-btn-wrapper">
20+
<a class="rmd-btn"
21+
href="https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook/blob/main/rmarkdown/casc.Rmd"
22+
target="_blank"
23+
rel="noreferrer">
24+
View RMarkdown File
25+
</a>
26+
</div>
27+
1928
The CAS Common Chemistry API provides programmatic access to a curated subset, offering information on nearly 500,000 chemical substances.
2029

2130
Please see the following resources for more information on API usage:

rmarkdown/chronam.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
by Michael T. Moen, Cyrus Gomes, Adam M. Nguyen, and Vincent F. Scalfani
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/chronam.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
The Library of Congress (loc\.gov) API provides programmatic access to Chronicling America, a vast collection of historic American newspapers, and other resources, enabling researchers and developers to search, retrieve, and analyze digitized newspaper pages and metadata.
1928

2029
Please see the following resources for more information on API usage:

rmarkdown/college-scorecard.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
by Michael T. Moen
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/college-scorecard.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
The College Scorecard API is an online tool hosted by the U.S. Department of Education that contains data concerning higher education institutions.
1928

2029
Please see the following resources for more information on API usage:

rmarkdown/crossref.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
by Michael T. Moen, Cyrus Gomes, Vincent F. Scalfani, and Adam M. Nguyen
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/crossref.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
The Crossref API provides metadata about publications, including articles, books, and conference proceedings. This metadata spans items such as author details, journal details, references, and DOIs (Digital Object Identifiers). Working with Crossref allows for programmatic access to bibliographic information and can streamline large-scale metadata retrieval.
1928

2029
Please see the following resources for more information on API usage:

rmarkdown/pubchem.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
by Vishank Patel, Adam M. Nguyen, and Michael T. Moen
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/pubchem.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
PubChem provides programmatic access to chemical data and bioactivity information from the National Center for Biotechnology Information (NCBI), enabling efficient retrieval and analysis of chemical structures, identifiers, properties, and associated biological activities.
1928

2029
Please see the following resources for more information on API usage:

rmarkdown/pubmed.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
by Michael T. Moen and Adam M. Nguyen
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/pubmed.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
The PubMed API, part of NCBI's Entrez Programming Utilities (E-utilities), provides programmatic access to biomedical literature from the PubMed database, enabling retrieval of bibliographic data.
1928

2029
Please see the following resources for more information on API usage:

rmarkdown/sage.Rmd

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
by Michael T. Moen
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/sage.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
Sage Journals allow downloading of articles for which you have legitimate access (e.g. open access articles and those included in your institution's subscription) for non-commercial text and data mining (see restrictions in terms below). Access to text and data mining with Sage resources requires prior approval. Contact UA Libraries or your institution to check their agreement and enable access. Please see the following resources below for more information on Sage text and data mining, API usage, and policies/terms:
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 Sage Journals.*
@@ -28,7 +37,7 @@ Sage Journals allow downloading of articles for which you have legitimate access
2837
- Data Reuse
2938
- <a href="https://www.sagepub.com/tdm-ai-policy" target="_blank">Sage Policy on Text and Data Mining (TDM) and Artificial Intelligence (AI)</a>
3039

31-
*This recipe uses the CrossRef API to obtain the full-text URLs of the articles, as recommended in <a href="https://journals.sagepub.com/page/policies/text-and-data-mining" target="_blank">Sage's Text and Data Mining overview</a>. For more information on usage for this API, please see our <a href="https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/src/overview/crossref.html" target="_blank">CrossRef cookbook tutorials</a> and the <a href="https://www.crossref.org/documentation/retrieve-metadata/rest-api/text-and-data-mining-for-researchers/" target="_blank">text and data mining for researchers page of CrossRef's API documentation</a>.*
40+
*This recipe uses the CrossRef API to obtain the full-text URLs of the articles, as recommended in <a href="https://journals.sagepub.com/page/policies/text-and-data-mining" target="_blank">Sage's Text and Data Mining overview</a>. For more information on usage for this API, please see our <a href="https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/overview/crossref.html" target="_blank">CrossRef cookbook tutorials</a> and the <a href="https://www.crossref.org/documentation/retrieve-metadata/rest-api/text-and-data-mining-for-researchers/" target="_blank">text and data mining for researchers page of CrossRef's API documentation</a>.*
3241

3342
**_NOTE:_** Sage Journals limits downloads to a maximum of 1 request every 6 seconds Monday to Friday from midnight to noon in the "America/Los_Angeles" timezone, and 1 request every 2 seconds outside of this time slot.
3443

@@ -40,8 +49,8 @@ Sage Journals allow downloading of articles for which you have legitimate access
4049

4150
The following external libraries need to be installed into your environment to run the code examples in this tutorial:
4251

43-
- <a href="https://cran.r-project.org/package=httr" target="_blank">httr</a>
44-
- <a href="https://cran.r-project.org/package=jsonlite" target="_blank">jsonlite</a>
52+
- <a href="https://cran.r-project.org/web/packages/httr/index.html" target="_blank">httr: Tools for Working with URLs and HTTP</a>
53+
- <a href="https://cran.r-project.org/web/packages/jsonlite/index.html" target="_blank">jsonlite: A Simple and Robust JSON Parser and Generator for R</a>
4554

4655
We load the libraries used in this tutorial below:
4756

rmarkdown/sdirect.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 Michael T. Moen
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/sdirect.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
These recipe examples demonstrate how to use Elsevier’s <a href="https://dev.elsevier.com/" target="_blank">ScienceDirect API</a> to retrieve full-text articles in various formats (XML, text).
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 Elsevier.*
@@ -34,7 +43,7 @@ _**NOTE:**_ See your institution's rate limit with <a href="https://dev.elsevier
3443

3544
*If you have copyright or other related text and data mining questions, please contact The University of Alabama Libraries or your respective library/institution.*
3645

37-
*These recipe examples were tested on March 23, 2026.*
46+
*These recipe examples were tested on April 7, 2026.*
3847

3948
## Setup
4049

rmarkdown/sec-edgar.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ knitr::opts_chunk$set(
1515

1616
by Adam M. Nguyen and Michael T. Moen
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/sec-edgar.Rmd"
21+
target="_blank"
22+
rel="noreferrer">
23+
View RMarkdown File
24+
</a>
25+
</div>
26+
1827
The U.S. Securities and Exchange Commission (SEC) allows free public access to documents filed by publicly traded companies in the Electronic Data Gathering, Analysis, and Retrieval (EDGAR) system.
1928

2029
Please see the following resources for more information on API usage:

0 commit comments

Comments
 (0)