Changes between Initial Version and Version 1 of rappture_R_api


Ignore:
Timestamp:
Nov 30, 2011, 2:39:59 AM (5 years ago)
Author:
dkearney
Comment:

adding initial doc for R bindings

Legend:

Unmodified
Added
Removed
Modified
  • rappture_R_api

    v1 v1  
     1= Rappture R API =
     2
     3
     4R bindings to the Rappture Development Toolkit.
     5
     6== Summary: ==
     7
     8=== __Load the Rappture module__ ===
     9  require(Rappture);
     10
     11=== __Create Rappture I/O object__ ===
     12  ''lib'' <- '''rp_lib'''(''path'') [[BR]]
     13
     14=== __Get input value__ ===
     15  ''val'' <- '''rp_lib_get_string'''(''lib'',''path'') [[BR]]
     16  ''val'' <- '''rp_lib_get_double'''(''lib'',''path'') [[BR]]
     17  ''val'' <- '''rp_lib_get_integer'''(''lib'',''path'') [[BR]]
     18  ''val'' <- '''rp_lib_get_boolean'''(''lib'',''path'') [[BR]]
     19  ''val'' <- '''rp_lib_get_file'''(''lib'',''path'') [[BR]]
     20
     21=== __Convert value__ ===
     22  ''val'' <- '''rp_units_convert_double'''(''from'',''to'') [[BR]]
     23  ''val'' <- '''rp_units_convert_string'''(''from'',''to'',''showUnits'') [[BR]]
     24
     25=== __Put output value__ ===
     26  '''rp_lib_put_string'''(''lib'',''path'',''value'',''append'') [[BR]]
     27  '''rp_lib_put_double'''(''lib'',''path'',''value'',''append'') [[BR]]
     28  '''rp_lib_put_file'''(''lib'',''path'',''fname'',''compress'',''append'') [[BR]]
     29
     30=== __Result__ ===
     31  '''rp_lib_result'''(''lib'') [[BR]]
     32
     33
     34-----------------------------
     35