Contributing to R-TDA

The R-TDA package is an open source project and we welcome your contributions and support in many forms.

Some ways that you can help are:

add functionality
reporting and fixing bugs
adding and improving documentation
suggesting improvements

Style guide

R Style Guide

Read https://google.github.io/styleguide/Rguide.xml

C++ Style Guide

Read https://google.github.io/styleguide/cppguide.html

Guidelines for Rd files

In \usage{} field, do not put more than 67 characters per line, to fit margin in pdf file.
Read https://developer.r-project.org/Rds.html
Use \code{} whenever it makes sense.
Use \href{}{} and \url{} to provide links.
Write reference as they appear in vignettes.
Do provide text alternatives for all but the very simplest \eqn and \deqn commands.
For description of each item in the argument, mention default value if the item has it.
Use explicit name rather than 'this'.
Avoid starting a sentence with math equation or code.