Changes between Initial Version and Version 1 of rappture_R_api

Timestamp:

Nov 29, 2011 11:39:59 PM (13 years ago)

Author:

dkearney

Comment:

adding initial doc for R bindings

rappture_R_api

@@ +1 @@
+= Rappture R API =
+
+
+R bindings to the Rappture Development Toolkit.
+
+== Summary: ==
+
+=== __Load the Rappture module__ ===
+  require(Rappture);
+
+=== __Create Rappture I/O object__ ===
+  ''lib'' <- '''rp_lib'''(''path'') [[BR]]
+
+=== __Get input value__ ===
+  ''val'' <- '''rp_lib_get_string'''(''lib'',''path'') [[BR]]
+  ''val'' <- '''rp_lib_get_double'''(''lib'',''path'') [[BR]]
+  ''val'' <- '''rp_lib_get_integer'''(''lib'',''path'') [[BR]]
+  ''val'' <- '''rp_lib_get_boolean'''(''lib'',''path'') [[BR]]
+  ''val'' <- '''rp_lib_get_file'''(''lib'',''path'') [[BR]]
+
+=== __Convert value__ ===
+  ''val'' <- '''rp_units_convert_double'''(''from'',''to'') [[BR]]
+  ''val'' <- '''rp_units_convert_string'''(''from'',''to'',''showUnits'') [[BR]]
+
+=== __Put output value__ ===
+  '''rp_lib_put_string'''(''lib'',''path'',''value'',''append'') [[BR]]
+  '''rp_lib_put_double'''(''lib'',''path'',''value'',''append'') [[BR]]
+  '''rp_lib_put_file'''(''lib'',''path'',''fname'',''compress'',''append'') [[BR]]
+
+=== __Result__ ===
+  '''rp_lib_result'''(''lib'') [[BR]]
+
+
+-----------------------------
+