Data

Tools

Indexes

Applications

Experiments

Open Source Science

research-impact-analysis

https://github.com/mcmasterrs/research-impact-analysis

Science Score: 44.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: McMasterRS
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 2.06 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created 10 months ago · Last pushed 7 months ago
Metadata Files
Readme License Citation Codemeta

README.md

research-impact-analysis

This project contains code to query data from OpenAlex APIs. The OpenAlex dataset describes scholarly entities and how those entities are connected to each other. Types of entities include works, authors, sources, institutions, topics, publishers, and funders.

Usage

The notebooks can be run on either Google Colab or Jupyter Notebook. An instruction to run the notebooks on Syzygy, a JupyterHub service provided by Digital Research Alliance of Canada, is provided in the docs/syzygy.md.

OpenAlex API Limitation

Querying Works by Author Using Author Entity API

While OpenAlex's Author entity API allows direct access to publication/citation count by years, the numbers does not match with the metrics shown in the web interface. The aggregation algorithm has issues causing the numbers from the API significantly larger than true values or the numbers shown in the web interface. This is confirmed by Jack Young and developers from OpenAlex.

It was then suggested by the developers to use the Work entity API and query all the publications by the author. Each publication has citation count by years and then the counts are aggregrated in the script. Using the Work entity API helps getting publication/citation numbers closer to the true values. However, upon further inspection to query results from the Work entity API, the API returns publications that do not belong to the author (even when using the Author's OpenAlex ID or ORCID in the query). It is suspected that these extra publications are published by authors with same/similar names.

Owner

  • Name: McMaster University Research Software
  • Login: McMasterRS
  • Kind: organization
  • Location: Hamilton, ON Canada

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: McMaster Research Impact Analysis
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Kelvin
    family-names: Lee
    email: lee887@mcmaster.ca
    affiliation: >-
      Research Software Development and Support, McMaster
      University Libraries, McMaster University
    orcid: 'https://orcid.org/0009-0000-7340-3204'
  - given-names: Jack
    family-names: Young
    email: jkyoung@mcmaster.ca
    affiliation: 'McMaster University Libraries, McMaster University'
    orcid: 'https://orcid.org/0000-0003-4626-0409'
identifiers:
  - type: doi
    value: 10.5281/zenodo.15640544
    description: The DOI representing all of the versions of this work
  - type: swh
    value: 'swh:1:dir:fc26adbbf69c4abcafa61e789184ec5ec526ea76'
    description: SWHID of the initial release
repository-code: 'https://github.com/McMasterRS/research-impact-analysis.git'
keywords:
  - research impact
  - bibliometrics
  - apc
license: MIT

CodeMeta (codemeta.json) 

{
  "@context": "https://w3id.org/codemeta/3.0",
  "type": "SoftwareSourceCode",
  "author": [
    {
      "id": "https://orcid.org/0009-0000-7340-3204",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Research Software Development and Support, McMaster University Libraries, McMaster University"
      },
      "email": "lee887@mcmaster.ca",
      "familyName": "Lee",
      "givenName": "Kelvin"
    },
    {
      "id": "https://orcid.org/0000-0003-4626-0409",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "McMaster University Libraries, McMaster University"
      },
      "email": "jkyoung@mcmaster.ca",
      "familyName": "Young",
      "givenName": "Jack"
    }
  ],
  "codeRepository": "https://github.com/McMasterRS/research-impact-analysis.git",
  "identifier": "https://doi.org/10.5281/zenodo.15640544",
  "keywords": [
    "research impact",
    "bibliometrics",
    "apc"
  ],
  "license": "https://spdx.org/licenses/MIT",
  "name": "McMaster Research Impact Analysis",
  "programmingLanguage": "Python 3",
  "softwareRequirements": [
    "https://pypi.org/project/pandas/",
    "https://pypi.org/project/numpy/",
    "https://pypi.org/project/requests/",
    "https://pypi.org/project/matplotlib/"
  ],
  "issueTracker": "https://github.com/McMasterRS/research-impact-analysis/issues"
}

GitHub Events

Total
  • Delete event: 3
  • Push event: 11
  • Public event: 1
  • Pull request event: 1
  • Create event: 1
Last Year
  • Delete event: 3
  • Push event: 11
  • Public event: 1
  • Pull request event: 1
  • Create event: 1

Dependencies

requirements.txt pypi
  • matplotlib *
  • numpy *
  • pandas *
  • requests *