Docs overhaul #431
Docs overhaul #431
Conversation
|
/preview-docs |
|
🚀 Deployed on https://67e478bce7f35616d80fb137--epipredict.netlify.app |
|
Our setup is generating docs in Also FYI: the bot edits its own comment for links. Each preview is a separate link and the links stick around for like 90 days. You can see the previous links in the comment edit history. Edit: this has been fixed on main so is no longer necessary |
dsweber2
force-pushed
the
docsDraft
branch
4 times, most recently
from
8044b98 to
d35363e
Compare
|
/preview-docs |
|
So something weird is happening with the plot for I added an option to replace the data for the autoplot so you can compare with new data instead |
|
Draft of the getting started is ready, moving on to a draft of the "guts" page (name a placeholder), which is an overview of creating workflows by hand |
After some digging, I don't think there are any bugs, just some edge-case behavior that we may not want:
My take away: never fit just the 5% and 95% quantiles. At least do the 50%. That fixes most of the jank this uncovers. |
|
/preview-docs |
|
Including 0.5 into the user's selection sounds simple and reasonable to me. They can always filter out what they don't want. |
|
/preview-docs |
|
/preview-docs @nmdefries this also updates the backtesting vignette; I'm dropping the Canadian example because it basically had no revisions. |
|
/preview-docs |
|
|
||
| ``` r | ||
| two_week_ahead <- arx_forecaster( | ||
| covid_case_death_rates, | ||
| four_week_ahead <- arx_forecaster( |
There was a problem hiding this comment.
issue: This gives me an error
Error in prep.epi_recipe(blueprint$recipe, training = training, fresh = blueprint$fresh, :
object 'validate_training_data' not found
I'm using the dev version of epipredict, installed today.
There was a problem hiding this comment.
That's internal to {recipes} (unexported). The DESCRIPTION may need to depend on a higher version. News.md here suggests 1.1.0, but worth looking.
There was a problem hiding this comment.
(Long term goal is to remove any dependence on internal functions from other packages)
There was a problem hiding this comment.
recipes 1.1.1 worked along with an update to hardhat
|
/preview-docs |
| ... | ||
| ) | ||
| ``` | ||
| ## Fitting multi-key panel data |
There was a problem hiding this comment.
issue: Plot titles are cut off. It doesn't matter for this example case exactly, but it doesn't make autoplot look stellar.
Not sure how best to fit the titles in a general way. We can wrap, or make the font smaller?
There was a problem hiding this comment.
That is unfortunate. I suspect trying to go all the way to a "publication-ready" plot via autoplot is probably more than we can reasonably handle. This package has some examples of text that is also oversized. I suspect dealing with that requires case by case reasoning, which is best addressed by the user doing a + theme(...) to deal with their case. Perhaps demoing that is worthwhile in this case
E.g. someone asking about auto-adjusting text size
For wrapping it seems there's no great way to go about it besides guess and check.
Choosing a theme where the titles can bleed over the edge like in the first link is probably a functional if ugly solution.
Checklist
Please:
dajmcdon.
DESCRIPTIONandNEWS.md.Always increment the patch version number (the third number), unless you are
making a release PR from dev to main, in which case increment the minor
version number (the second number).
(backwards-incompatible changes to the documented interface) are noted.
Collect the changes under the next release number (e.g. if you are on
0.7.2, then write your changes under the 0.8 heading).
epiprocessversion in theDESCRIPTIONfile ifepiprocesssoonepipredictandepiprocessChange explanations for reviewer
Draft ready for review:
Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch
symmetrizefor residuals #264nafill_bufferusage #320