Package uk.co.terminological.rjava

Annotation Type RClass

@Inherited @Retention(RUNTIME) @Target(TYPE) public @interface RClass
This annotation identifies a class as part of an R library api Fields here will populate data in DESCRIPTION file and allow R to load dependencies when it loads the R library api
Version:
$Id: $Id
Author:
terminological

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    exampleSetup
    The common setup for examples of non-static functions in this class.
    String[]
    imports
    A set of R library dependencies specified as the CRAN library name
    String[]
    suggests
    A set of R library suggestions specified as the CRAN library name
    String[]
    testSetup
    The common setup for tests of non-static functions in this class.

  • Element Details

    • imports

      String[] imports
      A set of R library dependencies specified as the CRAN library name
      Returns:
      the imports packages to add to the DESCRIPTION file
      Default:
      {}

    • suggests

      String[] suggests
      A set of R library suggestions specified as the CRAN library name
      Returns:
      the suggests packages to add to the DESCRIPTION file
      Default:
      {}

    • exampleSetup

      String[] exampleSetup
      The common setup for examples of non-static functions in this class.
      Returns:
      must be valid R code that provides necessary setup for manual examples of the generated code.
      Default:
      {}

    • testSetup

      String[] testSetup
      The common setup for tests of non-static functions in this class.
      Returns:
      must be valid R code that provides necessary setup for testing the generated code.
      Default:
      {}