cmu-delphi / cmu-delphi/epiprocess
Document the differences for column re-ordering in `new_epi_df` and `as_epi_df`
- Dominant language
- R
- Stars
- 12
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
It probably would be good to document the differences for column re-ordering in`new_epi_df` and `as_epi_df`. For ex., `new_epi_df` always has column re-ordering so that the columns are `geo_value, time_value ...` . In contrast, `as_epi_df` does not appear to enforce this column re-ordering when we're already feeding an epi_df to it (it simply returns the `epi_df` object unchanged). But it does enforce the column re-ordering if we are converting a `tbl_df`, `data frame`, or `tbl_ts` to an `epi_df` (as it ultimately calls `new_epi_df`).
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the documentation and entry points for `new_epi_df` and `as_epi_df`, then compare how each handles inputs that are already `epi_df` objects versus data frames or tibbles. Done means the documentation clearly states when columns are reordered and when an existing `epi_df` is returned unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100