Skip to content

Fix particular outstanding doc and vignette issues #217

Closed
@brookslogan

Description

@brookslogan
  • Fix "%s" in epix_fill_through_version docs.
  • "[...] typo in the readme file("functions in the epiprocess package that operate on epi_df objects begin with epix", should be "epi_archive" objects)" --- thanks to Tianyue for flagging
  • Fix as_list_col confusing doc: "Should the new column be stored as a list column?" --- Roughly, "new column" should be "computations"; maybe edit some other words.
  • Remove compactify-is-not-metadata discussion from vignette.

Copy-pasting some additional items identified by Ryan in an old Slack thread:

  • on this page, we advertise “Get the epipredict R package” but the link takes you back to epiprocess
  • same page, we should probably advertise “Get the [epidatr] R package”, and not covidcast, when the former is ready
  • on this vignette, now that somebody changed the date range (?) from when I initially wrote it, some things look funny. The blue density for the lag 10 correlation (about halfway down) is weirdly bimodal. Also the argmax lag is now 22 (last plot) and not 18, as the text claims
  • In the reference index, we should write the titles using code style, so epi_df instead of epi_df, etc., because this is now possible: Use inline markdown for article/reference titles r-lib/pkgdown#2113
    • [before/after: check that GitHub Actions pkgdown has this update or otherwise does something reasonable]
  • We should go through and make sure that no messages/warnings appear in vignettes that are not important. Like any package loading message or warning, and silly ggplot message or warning , etc. I thought I caught all of them when I wrote vignettes but I either missed some or some new ones got introduced.
  • The "Attribution" section at the bottom of each vignette page starts with "This document contains dataset ...". Let's change that to "This document contains a data set ..."

Metadata

Metadata

Assignees

Labels

P0high prioritydocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions