https://github.com/maxheld83/biblids

Validating with bibliometric identifiers
https://github.com/maxheld83/biblids

bibliometrics doi rstats rstats-package

Last synced: 7 months ago
JSON representation

Validating with bibliometric identifiers

• Host: GitHub
• URL: https://github.com/maxheld83/biblids
• Owner: maxheld83
• License: mit
• Created: 2020-12-01T17:05:03.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-04-29T15:58:37.000Z (over 3 years ago)
• Last Synced: 2025-02-12T20:45:35.249Z (8 months ago)
• Topics: bibliometrics, doi, rstats, rstats-package
• Language: R
• Homepage: https://maxheld.de/biblids/
• Size: 312 KB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# biblids

[![Main](https://github.com/subugoe/biblids/workflows/.github/workflows/main.yaml/badge.svg)](https://github.com/subugoe/biblids/actions)

[![Codecov test coverage](https://codecov.io/gh/subugoe/biblids/branch/master/graph/badge.svg)](https://codecov.io/gh/subugoe/biblids?branch=master)

[![CRAN status](https://www.r-pkg.org/badges/version/biblids)](https://CRAN.R-project.org/package=biblids)

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

In bibliometric analysis, we frequently work with specialised identifiers, such as [Digital Object Identifiers (DOIs)](https://www.doi.org) or [Research Organisation Registry IDs (RORs)](https://ror.org).

The goal of biblids is to help you work with these identifiers.

## Vctrs S3 Classes

Biblids implements bibliometric identifiers as S3 classes based on the [vctrs](https://vctrs.r-lib.org) package.

These object-oriented (OO) extensions teach R what, for example, a DOI is.

You don't have to know anything about OO, vctrs or even S3 to use biblids.

Bibliographic identifiers should just work as you might expect them to.

For example, with biblids, R "understands" that `10.1038/nphys1170`, `https://doi.org/10.1038/nphys1170` and `10.1038/NPHYS1170` are all the same DOI.

Each bibliometric identifier comes with a family of functions:

- A **constructor** function to help you create valid IDs, such as `doi()` for the `biblids_doi` class.

- **Casting** methods to help you **normalise** IDs, such as `as_doi()`.

- **Extraction** functions to extract valid IDs from arbitrary text such as `str_extract_all_doi()` as well as the underlying **regular expressions** `regex_doi()`.

- **Predicate** functions to test whether some object is (`is_doi()`) or could be (`is_doi_ish()`) a bibliometric ID.

- **Some examples** to play with, such as `doi_examples()`.

- **Other methods** to fully support bibliometrics in R, including for presentation (`format()`), logic (`is.na()`) or arithmetic.

For large sets of identifiers (such as the DOIs), only the syntax is validated.

For smaller sets (such as RORs), the package ships with datasets including presently valid identifiers, or wrappers to pull such information from external sources.

## Optional Extensions

Biblids is designed to be lightweight and comes with minimal `Imports` dependencies.

To install the package with minimal dependencies run:

```r

remotes::install_github("subugoe/biblids")

```

Additional features are enabled when you have `Suggests` packages installed.

Install these extended dependencies by running:

```r

remotes::install_github("subugoe/biblids", dependencies = TRUE)

```

### Presentation Methods

Bibliographic IDs are displayed appropriately in various output formats, such as inside [knitr](https://yihui.org/knitr/)/[rmarkdown](https://rmarkdown.rstudio.com) documents and [tibble](http://tibble.tidyverse.org) tables.

For example, `knit_print.biblids_doi()` will automatically render DOIs appropriately.

### Shiny Input Modules

You can rely on ready-made, well-tested [shiny](https://shiny.rstudio.com) input modules to ingest and validate bibliographic identifiers.

This may be helpful inside a bibliographic dashboard or another shiny app, where users can supply their own data for an analysis.

For example, you can ingest DOIs using `doiEntryApp()`.

### Minimal API Clients

Biblids also includes some API clients to resolve bibliomatric IDs and query related databases.

These clients are minimal API clients in the spirit of [gh](https://github.com/r-lib/gh).

They do *not* comprehensively duplicate external APIs in an R interface.

These wrappers are limited:

- They only cover APIs which do not already have an R client (such as [rcrossref](https://github.com/ropensci/rcrossref)).

- They only cover relatively simple APIs, where the output can be transformed into a straightforward R object.

They come in two forms:

1. You can use a thin wrapper around [httr](https://httr.r-lib.org) two write your own queries.

    These will usually return a deeply nested list for you to wrangle.

    

    For example, you can "roll your own" query with `get_doi_handles()`.

1. You can use some ready-made R functions with common queries baked in.

    These will usually return a simple vector.

    

    For example, you can test whether a doi has been published with `is_doi_found()`, or retrieve the resolved URL `resolve_doi()`.