Skip to content
New issue

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

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

Already on GitHub? # to your account

adopt style guide for R code and examples #52

Closed
3 tasks done
jeremydouglass opened this issue May 12, 2017 · 4 comments
Closed
3 tasks done

adopt style guide for R code and examples #52

jeremydouglass opened this issue May 12, 2017 · 4 comments

Comments

@jeremydouglass
Copy link
Member

jeremydouglass commented May 12, 2017

All R example code and documentation should largely conform to some consistent R code style guide -- ideally one that already exists, rather than the project developing its own.

Here is one example:

Future documentation efforts would:

  • choose an R style guide
  • reference the chosen style guide in the wiki / documentation
  • correct issues of style in example code to conform

Example style consistency will be especially useful because some Processing.R users are more likely to be confused by readability issues, and may also be learning R syntax for the first time by way of Processing.

@jeremydouglass
Copy link
Member Author

...it might also be worth reviewing all documentation and example R code for consistency using static analysis, e.g.:

@gaocegege
Copy link
Member

gaocegege commented May 19, 2017

I have imported coala which is a command line code linting tool. It will check the style of the code(both Java and R). Thanks to the awesome tool, the code has been prettified.

And I have added coala into ci. If there are some issues about code style in the code, the CI build will fail.

@jeremydouglass
Copy link
Member Author

Great work!

@gaocegege
Copy link
Member

😄 Thanks

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

2 participants