Documentation Example uses undefined data variable

yutannihilation / gghighlight

Highlight points and lines in ggplot2

https://yutannihilation.github.io/gghighlight/

Other

522 stars 23 forks source link

Closed evensolberg closed 2 years ago

evensolberg commented 3 years ago

The examples in the README.md use the variable d for data, but nowhere is d actually defined.

If this is just a "random" data set, perhaps the example could be reworked with actual data, such as mtcars?

yutannihilation commented 3 years ago

Oh, good point, thanks. Currently the data is generated by this code, which I felt a bit too long to show:

I don't think mtcars is a good example data for gghighlight. We need some more messy data like the current one. Feel free to suggest a nice one!

evensolberg commented 3 years ago

That chunk isn't that long IMHO. Especially if you just put it in a separate paragraph initially.

yutannihilation commented 3 years ago

Imho, this is too long.

yutannihilation commented 3 years ago

Just in case you don't notice, I included it in the getting started vignette.

evensolberg commented 3 years ago

I did not. Thanks. Perhaps a quick note about that could be placed near the top of the README? That would take care of it nicely. :-)