Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve database: add first author name et al to Reference column #348

Merged
merged 3 commits into from
Jul 15, 2024

Conversation

jamesmbaazam
Copy link
Member

  • Please check if the PR fulfills these requirements
  • I have read the CONTRIBUTING guidelines
  • A new item has been added to NEWS.md
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Checks have been run locally and pass
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Docs update.

  • What is the current behavior? (You can also link to an open issue here)

The parameter database has a "Reference" column that only lists the DOI, making it hard to know who published the paper.

  • What is the new behavior (if this is a feature change)?

Improves the "reference" column by adding the first author's family name et al and year.

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

No.

  • Other information:

This PR fixes #347.

Copy link
Member

@joshwlambert joshwlambert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I rendered the database vignette with the new changes made in this PR some of the entries did not render as expected. These include: single author entries that do not require "et al.", double author entries that should state both author names, and entries where the first author is an organisation or team (e.g. WHO Ebola response team) where they do not have a family name ($family).

I'll fix these on this PR and then merge.

@joshwlambert joshwlambert merged commit 2bdcd15 into main Jul 15, 2024
8 checks passed
@joshwlambert joshwlambert deleted the database branch July 15, 2024 12:41
@joshwlambert
Copy link
Member

Thank you for proposing and making this change @jamesmbaazam, it's definitely an improvement to the usability of the database.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include author list in parameter database
2 participants