Skip to content

epiprocess doc cleanup #563

Closed
Closed
@brookslogan

Description

@brookslogan
  • Fix non-linked vignette("backtesting", package="epipredict") in archive vignette; downlit should be linking this if it exists? downlit might be unable to link because we're not on CRAN yet.
  • "Data frame returns will be tidyr::unpack()-ed, if named, and will be tidyr::pack-ed columns, if not named."
    • This is the opposite of what happens; we pack only if they are "named" using .new_col_name =. Readers may also confuse "named" with "has column names", which data.frames should/must have, or maybe even row names.
  • Link/use to deaths-from-cases&deaths forecasting example instead of current bad examples.
  • Document NA-filling of input windows in epi_slide.
  • Fix mix of [.]version[s] and [.]ref_time_value[s] in ?epix_slide. (We might mention you can use .ref_time_value as well as .version inside formulas and data-masking expressions, but we should point to .version first in this case, and to version/.versions in all other discussion.)
  • Make ?epi[x]_slide actually describe what they do. (Starting paragraph maybe isn't really that clear.)
  • [-] Try to remove some unnecessary details/comparison in ?epix_slide
  • Remove link to removed "advanced" vignette.
  • Remove bad epix_slide example
  • [-] Remove overly-complicated / less relevant vignettes.
  • Fix garbled .all_versions docs
  • Fix Details: second bullet point formatting regarding .all_versions
  • [-] Separate out new_* functions into separate documentation pages?
  • Fix misleading/confusing ?epi_df "Slides a given function over variables in an epi_df object.`"
  • Replace median example in ?epi_df with something that's not dominated by epi_slide_opt(frollapply).
  • NEWS: add non-technical main highlights
  • Describe NA behavior noted below.

Thanks @XuedaShen for identifying some of these.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions