nmfs-ost / nmfs-ost/asar

[feat] incorporate all stock assessment report citations from SIS into .bib file

Open
#520 1 comment 0 reactions 1 assignee View on GitHub

@Schiano-NOAA is already working on this.

Since Aug 3, 2026.

Dominant language
R
Stars
44
Forks
10
Avg merge
1d 19h
Merged PRs (30d)
18

Description

To Do:

  • create JSON template with necessary metadata
  • create function to format all metadata from JSON from SIS to bibtex (in journals)
  • Create ghaction to extract file from journals quarterly and save file as inst/resources/sar_references.bib (maybe all refs?)
  • add in new bib file into list of bib files in template report yaml?

Notes:

  • The json file should follow the format
[{
    "author": ["name of each author", "number 2"],
    "title": "title of the report",
    "institution": "the sponsoring or publishing institution or organization",
    "year": "year of publication",
    "type": "Stock Assessment",
    "number": "specific report number or series identifier",
    "address": "address or location of the institution (city, state, or country)",
    "month": "month of publication",
    "url": "[optional] web link to access the report online",
    "doi": "[optional] digital object identifier"
}, {
    "author": ["name of each author", "number 2"],
    "title": "title of the report",
    "institution": "the sponsoring or publishing institution or organization",
    "year": "year of publication",
    "type": "Stock Assessment",
    "number": "specific report number or series identifier",
    "address": "address or location of the institution (city, state, or country)",
    "month": "month of publication",
    "url": "[optional] web link to access the report online",
    "doi": "[optional] digital object identifier"
}]
  • there is not key entry bc this should be generated inside of the function where it (1) combines the first author's last name and year of publication and (2) checks if this key has already been used and adds a, b., c, d, ... to the end of it (also checks if a, b, c etc are already present and adds next value)

I am aiming for a citation to render as follows in the report:
NOAA Fisheries OST. Sep 2026. Status of Petrale Sole off the U.S. West Coast. Silver Spring, MD. Accessible at https://github.com/nmfs-ost/asar.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.