Clarify scope of hubverse functionality and document canonical colnames requirements
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 5
- Forks
- 2
- Avg merge
- 2d 6m
- Merged PRs (30d)
- 7
Description
Noticed that the standard hubverse columns in hubUtils::std_colnames are different from the ones proposed in https://github.com/CDCgov/forecasttools/pull/102.
My understanding is that forecasttools is built for submissions to cdcepi/FluSight-forecast-hub and CDCgov/covid19-forecast-hub.
If that is true, we should note it somewhere. We should also separately add generic colnames, and colnames for each hub as constants in forecasttools, as is being done in https://github.com/CDCgov/forecasttools/pull/102.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing hubUtils::std_colnames with the canonical columns proposed in forecasttools PR #102, then confirm the intended relationship to the FluSight and COVID-19 forecast hubs. Done means the project scope is documented and generic, FluSight-specific, and COVID-19-specific column-name constants are clearly defined in forecasttools.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- data, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100