Skip to content

Documentation: R6, Naming, Args... #28

@mmyrte

Description

@mmyrte
  • consistent naming: create_ vs set_ methods
    • good enough for now, only remaining: set_report, set_neighbors (needs to be set method), set_full_trans_preds
  • document r6
    • remaining:
  • document all methods
  • see which R CMD check issues are related to roxygen, i.e. docs+namespace issues

move documentation for r6 methods to this format:

#' TestClass$Is
#'
#' Static method to test whether x is a TestClass object
#' @name TestClass$Is
#' @param x An object to test
#' @return TRUE iff x is a TestClass object
TestClass$Is <- function(x){
    
}

https://stackoverflow.com/questions/78332809/document-r6-static-method-with-roxygen

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    In progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions