search

ococrook / hdxstats

hdxstats: An R-package for statistical analysis of hydrogen deuterium exchange mass-spectrometry data.
Apache License 2.0
5 stars 2 forks source link

Vignette's content enhancements #15

Open broncio123 opened 2 years ago

broncio123 commented 2 years ago

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 commented 2 years ago

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

ococrook commented 2 years ago

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