XX
refers to generic function or class and is purely for illustrative example.roxygen2
.Conventions for Writing Public Methods (initialized in public
list and accessed by self$XX()
):
ix = NULL
then return the whole list)(if ix = NULL
set the entire object)Getters & Setters:
set_XX(XX, ix = NULL)
: XX
is the new replacement, if the field XX
is indexed (ie; a vector or list), ix
is the index to replace. If ix = NULL
, the entire field is replaced.get_XX(ix = NULL)
: If the field XX
is indexed (ie; a vector or list), ix
is the index to get If ix = NULL
, the entire field is returned.Pointers:
XX.Setup()
are functions called before any R6Class
objects are created in an environment, and directly add/modify methods and fields in R6ClassGenerator
objects.
XX.Init()
are methods attached to R6ClassGenerator
objects that initialize certain parameters or fields of R6Class
objects that already exist in an environment. They are not typically called during construction of the object and are usually called afterwards, with user input, prior to beginning a simulation.
XX.Parameters()
are functions that usually return a list of parameters, and are typically called with default arguments during initialization and whose output is typically assigned to a private field of the form private$XX_PAR
.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.