https://github.com/ropensci/aRxiv

Programmatic interface to the Arxiv API
https://github.com/ropensci/aRxiv

arxiv arxiv-analytics arxiv-api arxiv-org r r-package rstats

Last synced: 3 months ago
JSON representation

Programmatic interface to the Arxiv API

• Host: GitHub
• URL: https://github.com/ropensci/aRxiv
• Owner: ropensci
• License: other
• Created: 2014-03-04T04:13:36.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-02-29T17:43:13.000Z (8 months ago)
• Last Synced: 2024-05-12T08:41:09.654Z (6 months ago)
• Topics: arxiv, arxiv-analytics, arxiv-api, arxiv-org, r, r-package, rstats
• Language: R
• Homepage: https://docs.ropensci.org/aRxiv
• Size: 327 KB
• Stars: 59
• Watchers: 10
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aRxiv

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](

https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/aRxiv)](https://cran.r-project.org/package=aRxiv)

## R interface to arXiv

[arXiv](https://arxiv.org) is a repository of electronic preprints for

computer science, mathematics, physics, quantitative biology,

quantitative finance, and statistics. The

[aRxiv](https://github.com/ropensci/aRxiv) package is an R interface to

the [arXiv API](https://arxiv.org/help/api/index.html).

Note that the arXiv API _does not_ require an API key.

## Package Status and Installation

[![R-CMD-check](https://github.com/ropensci/aRxiv/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/aRxiv/actions/workflows/R-CMD-check.yaml)

[![codecov](https://codecov.io/gh/ropensci/aRxiv/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ropensci/aRxiv)

[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/aRxiv?color=blue)](https://github.com/r-hub/cranlogs.app)

__Installation instructions__

__Stable Version__

You can install the package via [CRAN](https://cran.r-project.org):

```r

install.packages("aRxiv")

```

__Development Version__

Or use `remotes::install_github()` to get the (more recent) version

at [GitHub](https://github.com/rOpenSci/aRxiv):

```r

install.packages("remotes")

library(remotes)

install_github("ropensci/aRxiv")

```

## Usage

### Basic usage

The main function is `arxiv_search()`. Here's an example of its use:

```r

library(aRxiv)

z <- arxiv_search(query = 'au:"Peter Hall" AND cat:stat*', limit=50)

str(z)

```

### Tutorial

An aRxiv tutorial is available at the rOpenSci website, [here](https://docs.ropensci.org/aRxiv/articles/aRxiv.html).

To view the tutorial from R, use:

```r

vignette("aRxiv", "aRxiv")

```

### Links

* [arXiv](https://arxiv.org)

* [arXiv API](https://arxiv.org/help/api/index.html)

* [arXiv API user manual](https://arxiv.org/help/api/user-manual.html)

* [Bulk data access to arXiv](https://arxiv.org/help/bulk_data)

* [Bulk data access to arXiv metadata via OAI-PMH](https://arxiv.org/help/oa/index.html)

* [Bulk data access to arXiv PDFs and source docs](https://arxiv.org/help/bulk_data_s3.html)

### License

Licensed under the [MIT license](https://cran.r-project.org/web/licenses/MIT). ([More information here](https://en.wikipedia.org/wiki/MIT_License).)

---

## Citation

Get citation information for `aRxiv` in R by running: `citation(package = 'aRxiv')`

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/ropensci/aRxiv/blob/master/CONDUCT.md).

By participating in this project you agree to abide by its terms.

[![ropensci footer](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)