Skip to content

Conversation

nmdefries
Copy link
Collaborator

Make sure README is up-to-date. Highlights:

  • Described new file structure
  • Described new release procedure
  • Added background info section with links to resources
  • Reorganized README for better flow

@nmdefries nmdefries marked this pull request as ready for review May 3, 2023 21:57
@nmdefries nmdefries requested a review from krivard May 3, 2023 21:57
Copy link
Contributor

@krivard krivard left a comment

Choose a reason for hiding this comment

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

Can merge as-is, two questions to resolve, several optional quibbles

DESCRIPTION Outdated
Comment on lines 4 to 7
Authors@R: c(person("Kate", "Harwood", email = "[email protected]", role = "aut"),
person("Chris", "Scott", role = "ctb"),
person("Jed", "Grabman", role = "ctb"))
Description: This app collects and scores COVID-19 forecasts submitted to the CDC and displays the results in an RShiny dashboard.
person("Jed", "Grabman", role = "ctb")),
person("Nat", "DeFries", role = c("aut", "cre")))
Copy link
Contributor

Choose a reason for hiding this comment

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

Question: Should we also drop Kate's andrew email and add Nat's?

Annotation: for future travelers: cre indicates the package maintainer; aut includes both original and ongoing primary authorship.

Source: https://journal.r-project.org/archive/2012-1/RJournal_2012-1_Hornik~et~al.pdf

@nmdefries nmdefries merged commit 9ff79d8 into dev May 5, 2023
@nmdefries nmdefries deleted the ndefries/modernize-readme branch May 5, 2023 22:09
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.

2 participants