moodymudskipper / tb

IN ~PROGRESS my own take on `[.data.frame`
0 stars 0 forks source link

Documentation organization #35

Open moodymudskipper opened 4 years ago

moodymudskipper commented 4 years ago

I think we need to put help for both tb() and [.tb on the same ?tb help file. This help file will be kept short and will be used to redirect to other help files. I think it should document i, j and briefly dots (with links to details on mutate, rename, spread, aggregate features) and just reference other features.

Our args will be referenced by ?.foo, so we'd have ?.by, ?.stack etc.

We could have tidyverse equivalent help files

So we can call ?tb_mutate and we get examples with equivalent dplyr code inside of dontrun{} + additional explanations.

?.fill will go to the documentation of the .fill arg, and ?tb_fill will show equivalent examples.

The good thing is that it'd be part of the help reference, so the main doc can almost read like a vignette.

We'll use aliases so to document ?tb_summarize_at, ?tb_summarize_if, ?tb_summarize_all on the same page. For pivoting functions we'll document tb_pivot_longer, ?tb_melt , tb_gather on the same page too.