Skip to content
This repository has been archived by the owner on Jun 24, 2022. It is now read-only.

terminological/r6-generator-runtime

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

r6-generator-runtime

DOI

Runtime maven dependency for annotation processor and java utilities for mapping to and from R supported data structures

This package contains necessary annotations and data structures that are required for the Java developer who is trying to create an R library using the r6-generator-maven-plugin, and is a required dependency of such a project.

The main part of the project are the annotations and the data structures

import uk.co.terminological.rjava.RClass;
import uk.co.terminological.rjava.RMethod;
import uk.co.terminological.rjava.types.*;

These allow you to specify an API for using your java code in R like so:

package 

import uk.co.terminological.rjava.RClass;
import uk.co.terminological.rjava.RMethod;

/**
 * A test of the r6 templating
 * 
 * this is a details comment 
 * @author joe tester joe.tester@example.com ORCIDID
 * 
 */
@RClass
public class HelloWorld {

	/**
	 * Description of a hello world function
	 * @return this java method returns a String
	 */
	@RMethod(examples = {
					"An example",
					"Spans many lines"
	})
	public static String greet() {
		return "Hello R world. Love from Java."
	}
}

For a minimal example and the main maven plugin code see: https://github.com/terminological/r6-generator-maven-plugin

For a more complete working example and further documentation see: https://github.com/terminological/r6-generator-maven-plugin-test

Datatype conversion

The philodopy of the plugin

About

runtime support library for code generated by the r6-generator-maven-plugin

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages