search

grantmcdermott / tinyplot

Lightweight extension of the base R graphics system
https://grantmcdermott.com/tinyplot
Apache License 2.0
259 stars 8 forks source link

intro plt() alias discussion #262

Open vincentarelbundock opened 6 days ago

vincentarelbundock commented 6 days ago

The plt() tooltip is great and highly visible.

I moved it to just after we call tinyplot() for the first time, so users see it immediately.

I removed the section on plt(). IMHO, the tooltip is already very visible, and spending a full section on an alias at the top of the intro vignette is overkill. The start of the introduction in prime real estate in a tutorial, and we should invest it on "real" features.

grantmcdermott commented 6 days ago

You make a good point. But, in that case, should we just go all the way and move the tooltip to the very top of the document? (I.e. Just after the main heading.)

vincentarelbundock commented 6 days ago

Well I think the main function should be presented before its alias. Otherwise we can't even answer: "alias to what?"

But anywhere after the first evaluated tinyplot() call is fine, I think.