Package uk.co.terminological.rjava

Annotation Type RMethod

@Inherited @Retention(RUNTIME) @Target({METHOD,CONSTRUCTOR}) public @interface RMethod
Methods marked by this annotation will be included in the R library api. In the R API methods must all have different names so method or constructor overloading is not supported. Both static and non-static methods are supported allowing for factory style constructors. Methods annotated with this block the R process and cannot be interrupted. For this reason they should always return a value in a socially acceptable time frame. If there is the possibility the method can hang then using an `RBlocking` or `RAsync` alternative annotation is preferred. examples field is used to populate .Rd files
Version:
$Id: $Id
Author:
terminological

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    examples
    Populate R examples.
    String[]
    tests
    Populate R testthat tests.

  • Element Details

    • examples

      String[] examples
      Populate R examples. For non static methods this will be combined with @RClass(exampleSetup) annotation to construct a complete example. For static methods (and constructors) the examples will be run as is. Use try({}) in examples you are not sure about or are developing. Please use single quotes only in R expressions (don't try escaping double quotes)
      Returns:
      A list of R commands that will be executed as an example of this function.
      Default:
      {}

    • tests

      String[] tests
      Populate R testthat tests. For non static methods this will be combined with @RClass(testSetup) annotation to construct a complete test. For static methods (and constructors) the examples will be run as is. Use try({}) in examples you are not sure about or are developing. Please use single quotes only in R expressions (don't try escaping double quotes)
      Returns:
      A list of R commands that will be executed as a test of this function.
      Default:
      {}