fair-amd-oct-paper-code

Code associated with the paper on FAIR assessment of AMD-related datasets containing OCT data

https://github.com/fairdataihub/fair-amd-oct-paper-code

Science Score: 67.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
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary

Keywords

amd biomedical data eye fair oct
Last synced: 4 months ago · JSON representation ·

Repository

Code associated with the paper on FAIR assessment of AMD-related datasets containing OCT data

Basic Info
  • Host: GitHub
  • Owner: fairdataihub
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 1.27 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 2
Topics
amd biomedical data eye fair oct
Created over 1 year ago · Last pushed 10 months ago
Metadata Files
Readme Changelog License Citation Codemeta

README.md

Contributors Stargazers Issues MIT License DOI

Code: FAIR AMD OCT Datasets Paper

About

This is the code associated with the paper titled "Publicly Available Imaging Datasets for Age-related Macular Degeneration: Evaluation according to the Findable, Accessible, Interoperable, Reproducible (FAIR) Principles". Age-related macular degeneration (AMD), a leading cause of vision loss among older adults, affects more than 200 million people worldwide. In this paper, We evaluated openly available AMD-related datasets containing optical coherence tomography (OCT) data against the FAIR principles. This repository contains the Jupyter notebook developed to analyze data for the paper and generate figures. See this inventory for all related resources, including the paper.

Standards followed

The overall code is structured according to the FAIR-BioRS guidelines. The Python code in the Jupyter notebook main.ipynb follows the PEP8 guidelines. Functions are documented with docstring formatted following Google's style guide. All the dependencies are documented in the environment.yml file.

Using the Jupyter notebook

Prerequisites

We recommend using Anaconda to create and manage your development environment and using JupyterLab to run the notebook. All the subsequent instructions are provided assuming you are using Anaconda (Python 3 version) and JupyterLab.

Clone repo

Clone the repo or download as a zip and extract.

cd into the code folder

Open Anaconda prompt (Windows) or the system Command line interface then naviguate to the code ```sh cd .FAIR-AMD-OCT-paper-code

```

Setup conda env

sh $ conda env create -f environment.yml

Setup kernell for Jupyter lab

sh $ conda activate FAIR-AMD-OCT-paper-code $ conda install ipykernel $ ipython kernel install --user --name=<any_name_for_kernel> $ conda deactivate

Launch Jupyter lab

Launch Jupyter lab and naviguate to open the main.ipynb file. Make sure to change the kernel to the one created above (e.g., see here). We recommend to use the JupyterLab code formatter along with the Black and isort formatters to facilitate compliance with PEP8 if you are editing the notebook.

Inputs/outputs

The Jupyter notebook makes use of files in the dataset associated with the paper (see here). You will need to download the dataset at add it in the input folder (call the dataset folder 'dataset').

Outputs of the code include plots displayed in the notebook but also saved as files. These saved plot files are included in the output folder.

License

This work is licensed under MIT. See LICENSE for more information.

Feedback and contribution

Use the GitHub issues for submitting feedback or making suggestions. You can also work the repository and submit a pull request with suggestions.

How to cite

If you use this code, please cite the related paper (it will be listed here when available) and also cite this repository following the instructions on provided here on Zenodo for the specific version of this repository that you use.

Owner

  • Name: FAIR Data Innovations Hub
  • Login: fairdataihub
  • Kind: organization
  • Email: info@fairdataihub.org
  • Location: United States of America

We build open source tools to help researchers learn about and implement FAIR Data practices

Citation (CITATION.cff)

cff-version: 1.2.0
title: 'Code: FAIR AMD OCT Datasets Paper'
type: software
authors:
  - given-names: Nayoon
    family-names: Gim
    affiliation: Department of Ophthalmology, University of Washington (UW)
  - given-names: Bhavesh
    family-names: Patel
    affiliation: FAIR Data Innovations Hub, California Medical Innovations Institute
    orcid: https://orcid.org/0000-0002-0307-262X
identifiers:
  - type: doi
    value: 10.5281/zenodo.12662728
    description: Archive of the source code
repository-code: https://github.com/fairdataihub/code-FAIR-AMD-OCT-paper
abstract: >-
  This is the code associated with the paper title "Publicly Available Imaging
  Datasets for Age-related Macular Degeneration: Evaluation according to the
  Findable, Accessible, Interoperable, Reproducible (FAIR) Principles".
  Age-related macular degeneration (AMD), a leading cause of vision loss among
  older adults, affects more than 200 million people worldwide. In this paper,
  We evaluated openly available AMD-related datasets containing optical
  coherence tomography (OCT) data against the FAIR principles. This repository
  contains the Jupyter notebook developed to analyze data for the paper and
  generate figures.
keywords:
  - FAIR
  - Data
  - AMD
  - OCT
  - Eye
  - Biomedical
license: MIT
version: 1.2.0
date-released: '2025-02-25'
doi: 10.5281/zenodo.14926793

CodeMeta (codemeta.json)

{
  "@context": "https://w3id.org/codemeta/3.0",
  "type": "SoftwareSourceCode",
  "applicationCategory": "Biomedical research",
  "author": [
    {
      "id": "_:author_1",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Department of Ophthalmology, University of Washington (UW)"
      },
      "familyName": "Gim",
      "givenName": "Nayoon"
    },
    {
      "type": "Role",
      "schema:author": "_:author_1",
      "roleName": "Developer"
    },
    {
      "id": "https://orcid.org/0000-0002-0307-262X",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute"
      },
      "familyName": "Patel",
      "givenName": "Bhavesh"
    },
    {
      "type": "Role",
      "schema:author": "https://orcid.org/0000-0002-0307-262X"
    },
    {
      "type": "Role",
      "schema:author": "https://orcid.org/0000-0002-0307-262X",
      "roleName": "Project Lead"
    }
  ],
  "codeRepository": "https://github.com/fairdataihub/code-FAIR-AMD-OCT-paper",
  "dateCreated": "2024-06-20",
  "dateModified": "2025-02-25",
  "datePublished": "2024-07-28",
  "description": "This is the code associated with the paper title \"Publicly Available Imaging Datasets for Age-related Macular Degeneration: Evaluation according to the Findable, Accessible, Interoperable, Reproducible (FAIR) Principles\". Age-related macular degeneration (AMD), a leading cause of vision loss among older adults, affects more than 200 million people worldwide. In this paper, We evaluated openly available AMD-related datasets containing optical coherence tomography (OCT) data against the FAIR principles. This repository contains the Jupyter notebook developed to analyze data for the paper and generate figures.",
  "downloadUrl": "https://github.com/fairdataihub/code-FAIR-AMD-OCT-paper",
  "funder": {
    "type": "Organization",
    "name": "National Institute of Health"
  },
  "identifier": "10.5281/zenodo.14926793",
  "keywords": [
    "FAIR",
    "Data",
    "AMD",
    "OCT",
    "Eye",
    "Biomedical"
  ],
  "license": "https://spdx.org/licenses/MIT",
  "name": "Code: FAIR AMD OCT Datasets Paper",
  "programmingLanguage": [
    "Jupyter Notebook",
    "Python"
  ],
  "relatedLink": "https://github.com/fairdataihub/inventory-FAIR-AMD-OCT-paper",
  "releaseNotes": "First release",
  "softwareRequirements": "Python 3.11.4",
  "version": "1.2.0",
  "developmentStatus": "inactive",
  "issueTracker": "https://github.com/fairdataihub/code-FAIR-AMD-OCT-paper/issues"
}

GitHub Events

Total
  • Release event: 1
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 6
  • Pull request review event: 1
  • Pull request event: 2
  • Create event: 3
Last Year
  • Release event: 1
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 6
  • Pull request review event: 1
  • Pull request event: 2
  • Create event: 3

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 3
  • Total pull requests: 2
  • Average time to close issues: 18 minutes
  • Average time to close pull requests: less than a minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 3.0
  • Merged pull requests: 2
  • Bot issues: 3
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 3.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • codefair-app[bot] (1)
Pull Request Authors
  • bvhpatel (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

environment.yml pypi
  • matplotlib ==3.7.1
  • pandas ==1.5.3
  • seaborn ==0.12.2