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

Vignette's content enhancements #15

Open
broncio123 opened this issue Feb 9, 2022 · 2 comments
Open

Vignette's content enhancements #15

broncio123 opened this issue Feb 9, 2022 · 2 comments
Labels
code-review issues opened to define actions based on code review documentation Improvements or additions to documentation

Comments

@broncio123
Copy link
Collaborator

broncio123 commented Feb 9, 2022

Some amount of editing is required in the written text and the code commands to make it more user-friendly and readable
Here's a list of suggestions

  1. Some of the text may have to be rewritten,
    There seems to be a higher emphasis on introducing the statistical methodology and very little in terms of interpretation of its outputs.

  2. In terms of the commands,

  • Use self-descriptive variable names for input and output variables
    This could help to enhance the readability of code blocks, to emphasise the logic behind commands/functions called.
  • Breakdown long function/command calls via the definition of intermediate variables
    I base this comment on my experience with Python code, for which guidance on code writing standards has been laid out https://realpython.com/python-pep8/#naming-styles
@broncio123 broncio123 added documentation Improvements or additions to documentation code-review issues opened to define actions based on code review labels Feb 9, 2022
@broncio123
Copy link
Collaborator Author

applying style according to this guide
http://adv-r.had.co.nz/Style.html

@ococrook
Copy link
Owner

here are some more suggestions that I'd like to keep to: https://bioconductor.org/developers/how-to/coding-style/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-review issues opened to define actions based on code review documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants