rcrossref

R client for various CrossRef APIs

https://github.com/ropensci/rcrossref

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.5%) to scientific vocabulary

Keywords

api api-wrapper crossref-api doi metadata r r-package rstats

Keywords from Contributors

genome weather-data taxize taxonomy fish fishbase data-access geocode metagenomics carpentries
Last synced: 4 months ago · JSON representation

Repository

R client for various CrossRef APIs

Basic Info
Statistics
  • Stars: 174
  • Watchers: 22
  • Forks: 21
  • Open Issues: 22
  • Releases: 17
Topics
api api-wrapper crossref-api doi metadata r r-package rstats
Created over 12 years ago · Last pushed 5 months ago
Metadata Files
Readme Changelog Contributing License Codemeta

README.Rmd

rcrossref: R interface to Crossref APIs
=======================================

```{r echo=FALSE}
knitr::opts_chunk$set(
  comment = "#>",
  collapse = TRUE,
  warning = FALSE,
  message = FALSE
)
```

[![cran checks](https://badges.cranchecks.info/worst/rcrossref.svg)](https://cran.r-project.org/web/checks/check_results_rcrossref.html)
[![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)
[![R-check](https://github.com/ropensci/rcrossref/actions/workflows/R-check.yml/badge.svg)](https://github.com/ropensci/rcrossref/actions/workflows/R-check.yml)
[![codecov](https://codecov.io/gh/ropensci/rcrossref/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ropensci/rcrossref)
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/rcrossref)](https://github.com/r-hub/cranlogs.app)
[![cran version](https://www.r-pkg.org/badges/version/rcrossref)](https://cran.r-project.org/package=rcrossref)

## Crossref documentation

* Crossref API: https://api.crossref.org/
* Crossref's API issue tracker: https://crossref.atlassian.net/jira/software/c/projects/CR/issues/
* Crossref metadata search API: https://search.crossref.org/
* Crossref DOI Content Negotiation: https://www.crossref.org/documentation/retrieve-metadata/content-negotiation/
* Crossref Text and Data Mining (TDM) Services: www.crossref.org/documentation/retrieve-metadata/rest-api/text-and-data-mining/

## Installation

Stable version from CRAN

```{r eval=FALSE}
install.packages("rcrossref")
```

Or development version from GitHub

```{r eval=FALSE}
remotes::install_github("ropensci/rcrossref")
```

Load `rcrossref`

```{r}
library('rcrossref')
```

## Register for the Polite Pool

If you are intending to access Crossref regularly you will want to send your email address with your queries. This has the advantage that queries are placed in the polite pool of servers. Including your email address is good practice as described in the Crossref documentation (https://api.crossref.org/swagger-ui/index.html#access). The second advantage is that Crossref can contact you if there is a problem with a query.

Details on how to register your email in a call can be found at `?rcrossref-package`. To pass your email address to Crossref, simply store it as an environment variable in .Renviron like this:

Open file: `file.edit("~/.Renviron")`

Add email address to be shared with Crossref `crossref_email= "name@example.com"`

Save the file and restart your R session

To stop sharing your email when using rcrossref simply delete it from your .Renviron file. 

## Documentation

See https://docs.ropensci.org/rcrossref/ to get started

## Meta

* Please report any issues or bugs: https://github.com/ropensci/rcrossref/issues
* License: MIT
* Get citation information for `rcrossref` in R doing `citation(package = 'rcrossref')`
* Please note that this package is released with a Contributor Code of Conduct (https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

Owner

  • Name: rOpenSci
  • Login: ropensci
  • Kind: organization
  • Email: info@ropensci.org
  • Location: Berkeley, CA

CodeMeta (codemeta.json)

{
  "@context": [
    "http://purl.org/codemeta/2.0",
    "http://schema.org"
  ],
  "@type": "SoftwareSourceCode",
  "identifier": "rcrossref",
  "description": "Client for various 'CrossRef' 'APIs', including 'metadata' search\n    with their old and newer search 'APIs', get 'citations' in various formats\n    (including 'bibtex', 'citeproc-json', 'rdf-xml', etc.), convert 'DOIs'\n    to 'PMIDs', and 'vice versa', get citations for 'DOIs', and get links to\n    full text of articles when available.",
  "name": "rcrossref: Client for Various 'CrossRef' 'APIs'",
  "codeRepository": "https://github.com/ropensci/rcrossref",
  "issueTracker": "https://github.com/ropensci/rcrossref/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "1.1.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.0.2 Patched (2020-09-01 r79114)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Central R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Scott",
      "familyName": "Chamberlain",
      "email": "myrmecocystus@gmail.com",
      "@id": "https://orcid.org/0000-0003-1444-9135"
    },
    {
      "@type": "Person",
      "givenName": "Hao",
      "familyName": "Zhu"
    },
    {
      "@type": "Person",
      "givenName": "Najko",
      "familyName": "Jahn"
    },
    {
      "@type": "Person",
      "givenName": "Carl",
      "familyName": "Boettiger"
    },
    {
      "@type": "Person",
      "givenName": "Karthik",
      "familyName": "Ram"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Scott",
      "familyName": "Chamberlain",
      "email": "myrmecocystus@gmail.com",
      "@id": "https://orcid.org/0000-0003-1444-9135"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "roxygen2",
      "name": "roxygen2",
      "version": ">= 7.1.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=roxygen2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "vcr",
      "name": "vcr",
      "version": ">= 0.2.6",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=vcr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "bibtex",
      "name": "bibtex",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=bibtex"
    }
  ],
  "softwareRequirements": [
    {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "jsonlite",
      "name": "jsonlite",
      "version": ">= 1.5",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=jsonlite"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "crul",
      "name": "crul",
      "version": ">= 0.7.4",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=crul"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "xml2",
      "name": "xml2",
      "version": ">= 1.1.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=xml2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "plyr",
      "name": "plyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=plyr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "dplyr",
      "name": "dplyr",
      "version": ">= 0.7.4",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=dplyr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "tibble",
      "name": "tibble",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tibble"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "R6",
      "name": "R6",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=R6"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "shiny",
      "name": "shiny",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=shiny"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "miniUI",
      "name": "miniUI",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=miniUI"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "stringr",
      "name": "stringr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=stringr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "DT",
      "name": "DT",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=DT"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "stats",
      "name": "stats"
    }
  ],
  "contIntegration": "https://codecov.io/gh/ropensci/rcrossref",
  "developmentStatus": "https://www.repostatus.org/#active",
  "releaseNotes": "https://github.com/ropensci/rcrossref/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/rcrossref/blob/master/README.md",
  "fileSize": "0KB",
  "applicationCategory": "Literature",
  "isPartOf": "https://ropensci.org",
  "keywords": [
    "text-ming",
    "literature",
    "pdf",
    "xml",
    "publications",
    "citations",
    "full-text",
    "TDM",
    "Crossref",
    "crossref-api",
    "doi",
    "metadata",
    "api",
    "r",
    "rstats",
    "api-wrapper",
    "r-package"
  ],
  "contributor": {},
  "copyrightHolder": {},
  "funder": {},
  "relatedLink": "https://docs.ropensci.org/rcrossref"
}

GitHub Events

Total
  • Issues event: 5
  • Watch event: 8
  • Issue comment event: 11
  • Push event: 3
  • Pull request event: 3
  • Fork event: 1
Last Year
  • Issues event: 5
  • Watch event: 8
  • Issue comment event: 11
  • Push event: 3
  • Pull request event: 3
  • Fork event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 682
  • Total Committers: 17
  • Avg Commits per committer: 40.118
  • Development Distribution Score (DDS): 0.15
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Scott Chamberlain m****s@g****m 580
naja n****n@g****m 50
Hao Zhu h****3@g****m 15
Carl Boettiger c****g@g****m 9
Noam Ross n****s@g****m 6
Karthik Ram k****m@g****m 5
Seferin James S****s@b****m 3
Lukas Wallrich l****h@g****m 3
Salim B s****m@p****e 2
Martin R. Smith m****s@g****m 2
Danny Garside d****e@o****m 1
Katrin Leinweber 9****r 1
Martin John Hadley m****y@g****m 1
Paul Oldham p****m 1
rOpenSci Bot m****t@g****m 1
Martin Fenner m****r@p****g 1
Luis Montilla l****a@p****e 1
Committer Domains (Top 20 + Academic)

Packages

  • Total packages: 2
  • Total downloads:
    • cran 1,357 last-month
  • Total docker downloads: 193,763
  • Total dependent packages: 9
    (may contain duplicates)
  • Total dependent repositories: 43
    (may contain duplicates)
  • Total versions: 35
  • Total maintainers: 1
cran.r-project.org: rcrossref

Client for Various 'CrossRef' 'APIs'

  • Versions: 18
  • Dependent Packages: 9
  • Dependent Repositories: 43
  • Downloads: 1,357 Last month
  • Docker Downloads: 193,763
Rankings
Docker downloads count: 0.0%
Stargazers count: 2.6%
Forks count: 3.3%
Dependent repos count: 3.9%
Average: 5.0%
Dependent packages count: 5.7%
Downloads: 14.8%
Maintainers (1)
Last synced: 5 months ago
proxy.golang.org: github.com/ropensci/rcrossref
  • Versions: 17
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.7%
Dependent repos count: 5.9%
Last synced: 5 months ago

Dependencies

DESCRIPTION cran
  • DT * imports
  • R6 * imports
  • crul >= 0.7.4 imports
  • dplyr >= 0.7.4 imports
  • jsonlite >= 1.5 imports
  • methods * imports
  • miniUI * imports
  • plyr * imports
  • shiny * imports
  • stats * imports
  • stringr * imports
  • tibble * imports
  • utils * imports
  • xml2 >= 1.1.1 imports
  • bibtex * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • roxygen2 >= 7.1.0 suggests
  • testthat * suggests
  • vcr >= 0.2.6 suggests
  • withr * suggests
.github/workflows/R-check.yml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite