Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do an editing pass / cleanup of the vignette #83

Open
4 tasks
mjskay opened this issue Jan 28, 2020 · 0 comments
Open
4 tasks

Do an editing pass / cleanup of the vignette #83

mjskay opened this issue Jan 28, 2020 · 0 comments

Comments

@mjskay
Copy link
Contributor

mjskay commented Jan 28, 2020

Some things that it needs:

  • An intro to the package and a description of the basic concepts and how it works

    • Maybe some introduction to an abstract notation describing what's happening
  • Prose around the various pieces introducing and explaining them

  • Readable, consistent code style, especially to make it easy to see the parts of a spec. I'd suggest something like:

    data_frame %>%
      ggplot(aes(
        var = value,
        var2 = value2
      )) +
      geom_whatever() +
      whatever_else()

    or:

    data_frame %>%
      ggplot() +
      geom_whatever(aes(
        var = value,
        var2 = value2
      )) +
      whatever_else()

    or:

    ggplot(data_frame) +
      geom_whatever(aes(
        var = value,
        var2 = value2
      )) +
      whatever_else()

Basically something that makes it easy to read the value of each aesthetic mapping and which has consistent indentation (indenting out to parens on previous lines, by contrast, creates long lines and indentation amounts that don't reflect indentation level). The advantage of the pipe forms is that if you need to insert other data transformations ahead of the ggplot call you can do so, but if no examples end up needing that it's probably not necessary.

@mjskay mjskay added this to the CHI/CRAN ready milestone Jan 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant