Technical Specifications

General Overview

The Publication Facts Label presents information alongside a Reviewable Article. It contrasts the article's statistics against those for other reviewable articles, in order to inform the reader about norms and how this article compares to them.

Terminology

Fields & Calculations

  1. Peer reviewers: After this text, indicate the total number of peer reviewers who have provided reviews for this article. (If a single reviewer has reviewed the article in multiple rounds, they are only counted once.)
  2. Reviewer profiles: If the platform provides information about reviewer profiles, this text should be followed by "Yes", which should be a link to where the profiles can be viewed. If not, use the text "Reviewer profiles: N/A" to indicate "not applicable".
  3. Data availability: If the platform provides author data availability statements, this text should be followed by "Yes", which should be a link to where the statements can be found. If not, use the text "Data availability: N/A" to indicate "not applicable".
  4. External funding: This area indicates whether funding data is supported by the platform, and if so, whether it is available for this article. It can appear as follows:

    • If the platform does not support information about external funders, it should read External funding: N/A.
    • If the platform supports funding information and it has been entered for this article, it should read External funding: Yes, and the "Yes" should link to where the funding data is presented.
    • If the platform supports funding information but none has been entered for this article, it should read External funding: No.
  5. Competing interests: After this text, indicate whether Competing Interests are available for at least one of the article's authors. It can appear as follows:

    • If the platform does not support author Competing Interest statements, it should read Competing interests: N/A (for Not Applicable).
    • If the platform supports author Competing Interest statements but none have been provided for this article, it should read Competing interests: No.
    • If the platform supports author Competing Interest statements and at least one has been proviuded, it should read Competing Interests: Yes, and the "Yes" should link to where the competing interest statement(s) are presented.
  6. Articles accepted: After this text, include the percentage of reviewable articles in this repository that are accepted for publication.
  7. Days to publication: After this text, include number of days between the author's initial submission of this work in its current form and the date it was first published online.
  8. Indexed in: After this text, list (in as brief a form as possible) the major indexes in which this content appears. Each entry in the list should be a link to the article's record in the index. If that is not possible, link as closely as possible to the individual resource -- for example, to search results by the article's DOI or title.
  9. Editor & editorial board: After this text, link to a page listing the editorial board's profiles. If the platform supports verified ORCID identifiers for the editorial board, include the ORCID icon in compliance with ORCID's brand guidelines.
  10. Society: After this text, include the name of the academic society (if any) involved in the publication of this journal. If possible, link this text to the society's website. If the platform does not support designating an academic society, use the text "N/A" to indicate Not Available.
  11. Publisher: After this text, include the name of the journal's publisher. If possible, link this text to the publisher's website. If the platform does not support designating a publisher, use the text "N/A" to indicate Not Available.

Getting "Other articles" Statistics

Current statistics can be downloaded from https://pkp.sfu.ca/ojs/pflStatistics.json. We recommend downloading on e.g. a daily or weekly basis and caching locally. Statistics from your repository can be provided upstream when downloading these statistics; see the Contributing to Statistics section for details.

The JSON file's elements can be interpreted as follows:

Contributing to Statistics

Statistics from your repository can be provided upstream for inclusion in the "Other statistics" data by adding URL parameters when fetching the statistics.

Base URL: https://pkp.sfu.ca/ojs/pflStatistics.json

Additional parameters:

Example

    curl -G \
    -d "platform=ojs" \
    -d "version=1.0.0.1" \
    -d "journalUrl=https://publisher.test/journal" \
    -d "pflNumAcceptedClass=153" \
    -d "pflReviewerCountClass=2.5" \
    -d "pflCompetingInterestsClass=123" \
    -d "pflDataAvailabilityClass=58" \
    -d "pflNumHaveFundersClass=141" \
    -d "pflDaysToPublicationClass=150" \
    -d "reviewableSubmissionsCount=192" \
    -d "issn=1234-5678" \
    https://pkp.sfu.ca/ojs/pflStatistics.json
   

Integration

The Publication Facts Label is integrated into a publishing platform as a Web Component whose components are included in this repository. The steps for integration are:

  1. Add styling to the page to include the appropriate web font:
    
        
       
  2. Include an element in the page markup where you wish the Publication Facts Label to appear:

    
        
       
  3. Add Javascript to configure and present the Publication Facts Label web component:

    
        
       
  4. Adjust the parameters to the Javascript in the previos step to include values from your platform!