Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@citation-js/plugin-pubmed

citation-js575MIT0.3.0

Citation.js plugin for PubMed and PubMed Central.

PubMed, PubMed Central

readme

This plugin makes use of the Literature Citation Exporter web service, which takes a PubMed or PubMed Central identifier and returns CSL.

In 2022, NCBI added a rate limit to the API that this plugin uses to get metadata from PubMed Central and PubMed identifiers. This rate limit forbids concurrent requests, and allows no more than 3 requests per second. For more information, see https://api.ncbi.nlm.nih.gov/lit/ctxp/.

Install

npm install @citation-js/plugin-pubmed

Use

Install the plugin by require-ing it:

require('@citation-js/plugin-pubmed')

It can then be used in two ways. PubMed Central identifiers are easy to recognize and the following code can be used:

const citejs = require('@citation-js/core')
require('@citation-js/plugin-csl')
require('@citation-js/plugin-pubmed')

citejs.Cite.async('PMC6613236')
  .then(Cite =>
    console.log(Cite.format('bibliography', {template: 'vancouver'}))
  )

For PubMed identifiers, which are just numbers, one way is to just tell it is a PubMed identifier:

const citejs = require('@citation-js/core')
require('@citation-js/plugin-csl')
require('@citation-js/plugin-pubmed')

citejs.Cite.async('31209238', {forceType: '@pubmed/id'})
  .then(Cite =>
    console.log(Cite.format('bibliography', {template: 'vancouver'}))
  )

Formats

Formats and other features added by this plugin.

Input

As input it recognizes PubMed identifiers if prefixed with pmid:. Of course, you can also indicate in your source code that the PubMed integer is an PubMed identifier. If prefixed with PMC, then the identifier is recognized as a PubMed Central identifier.

Output

The output is CSL.

changelog

0.3.0 (2023-03-24)

0.2.1 (2022-05-30)

0.2.0 (2021-05-22)

  • chore!: update dependencies (34e0ef6)

BREAKING CHANGES

  • drop Node 8 support

0.1.1 (2019-08-16)

0.1.0 (2019-08-16)

Features

  • pubmed, pmc: support PubMed, PMC identifiers (87f9379)