Skip to content
GitLab
Open
Issue created by Nuria Pérez-Zanón@nperezMaintainer

Documentation updated: adding new function to MEDSCOPE

Dear @all,

Thanks to @eida contribution, the discussion about the procedure and convention to develop CSTools packages has triggered.

You can participate in the development of the documentation here.

This document is part of the guidelines to contribute to CSTools package (see below).

Please, if you have any question or comments you can also use this channel (creating issues in this GitLab project).

Thanks for your collaboration,

Núria

How to contribute

  • please, add one branch by feature (ideally, one by one function; if there's a dependency, you can add more than one).

  • you can follow this document for structuring the function and the data input and output. This guide only applies to data-intensive functions, in other words, the "big" functions that compute a statistical procedure, score, ... receiving large data arrays as functions. For "small" helper inputs, it is not needed to follow this.

  • could you check your R code style? For the coding style, we have adopted Google’s R style guide with some particularly discussed aspects:

  • Whether to keep comments or not: we will keep comments. The emacs-ESS commenting style will be used: a single ‘#’ symbol shifts the comment to the middle column, ‘##’ keeps the comment aligned with the code, and ‘###’ sends the comment to the left-most column
  • Whether to keep blank lines or not: we will not keep blank lines
  • Whether to replace all = assignments by the arrow assignment <-: yes
  • Whether to put the opening braces in a new line or not: no
  • Number of indentation spaces: 4
  • Maximum length of the lines: soft limit of 80

  • we're already developing the documentation using roxingen2 package. Basically, if you follow the header of AnoMultiMetric.R or MultivarRMSE.R functions, it would be mostly correct (other steps, as adding dependencies in the DESCRIPTION file, will also be necessary).

  • please, provide a minimum example within the function. If you can, I encourage you to develop a vignette (see MultiModelSkill_vignette.md or MultivarRMSE_vignette.md)

  • open a 'merge request' to start the revision (we will go through the previous documents to have a good package and to pass CRAN checks)