Instrucions for contributors

Hi! Thanks for considering to contribute to StealLikeBayes!

This article will give you an idea of what’s ahead of you to contribute to the repository and package. Begin by forking the repo on GitHub and opening an issue about your contribution. Just, open an issue by clicking New issue >> A new submission template. This issue will contain the following instructions:

Instructions to follow

• Fork the repository bsvars/StealLikeBayes.
• Edit this issue’s name by replacing part [main_routine] from its title by the name of the main routine you are contributing.
• Update this issue by providing details on the package and its files you are stealing the code from. Please provide links to the CRAN website and developers repository of this package.
• You are contributing to an R package. To ensure we meet the standards, please, implement all the recommendations from the book R Packages by Hadley Wickham and Jennifer Bryan.
• To learn about our requirements, study how function rgennorm() has been incorporated:
  • look at the contributed C++ file src/rgennorm.cpp,
  • and the corresponding C++ header file src/rgennorm.h.
  • Study the construction of the R wrapper in file R/rgennorm.R,
  • and the test file inst/tinytest/test_rgennorm.R.
  • Update your authorship in the DESCRIPTION,
  • and update the NEWS.md. That should be all! Thanks!
• Include your C++ file, src/[main_routine].cpp, named after the main routine/function you’re contributing called [main_routine].
  • Acknowledge the authorship of the source code in this file in line with its licence requirements.
  • Export all C++ functions by including Rcpp directives // [[Rcpp::interfaces(cpp)]] and // [[Rcpp::export]].
  • Write and R wrapper only for the main function you contribute.
• Include the corresponding C++ header file, src/[main_routine].h with all your C++ functions.
• Include one R file with a wrapper for your main C++ function, R/[main_routine].R.
  • This function must include argument type checks using stopifnot().
  • Include full documentation using roxygen2 that must have all necessary elements including:
  • the description of arguments and values, also described in terms of the C++ objects,
  • the acknowledgement of the original code authorship in @details with explicit references to the R package where the original code comes from listed in @references, the paper that developed the particular statistical method, and to the package defining the class of C++ inputs and outputs,
  • your authorship acknowledgement in section @authors,
  • an example of the R function use in @examples.
• Include an R file with tests of your contributed R function, inst/tinytest/test_[main_routine].R.
• Make your code nicely styled, readable, and expressive, that is, clearly representing a statistical procedure.
• Update on dependencies in DESCRIPTION and R/StealLikeBayes-package.R.
• Update on your authorship in DESCRIPTION, using person(). In comment include your ORCID and contributions, for instance contributions = "contributions: [main_routine]".
• Update the NEWS.md by providing the [main_routine], your GitHub profile login, and a link to this issue.
• Always push your commits linking them all to your issue by including the hash tag of your issue.
• Run checks of the package locally. They all need to pass!

Rcpp::compileAttributes()
devtools::document()
devtools::check()

• Submit your Pull Request.
• Respond to all the comments from the maintainer.