Skip to content

citation-js/plugin-pubmed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.