Skip to content

Commit 63b3fe8

Browse files
committed
R documentation minor tweaks
1 parent eb71601 commit 63b3fe8

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

Doc/Manual/R.html

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ <H1><a name="R">34 SWIG and R</a></H1>
3737
The R bindings are under active development. They have been used to
3838
compile and run an R interface to QuantLib running on Mandriva Linux
3939
with gcc. They are also used to create the SimpleITK R package, which
40-
runs on various linuxes and mac. Swig is used to create all wrapper
40+
runs on Linux and MacOS. SWIG is used to create all wrapper
4141
interfaces
4242
to <a href="http://http://www.simpleitk.org/">SimpleITK</a>. The R
4343
bindings also work on Microsoft Windows using Visual C++.
@@ -211,26 +211,30 @@ <H2><a name="R_nn6">34.6 C++ classes</a></H2>
211211
The R interface has the following capabilities:
212212
<ul>
213213
<li> Destructor methods are registered and called automatically by the R garbage collector.
214-
<li> A range of std::vector types are converted automatically to R equivalents.
214+
<li> A range of std::vector types are converted automatically to R equivalents via the std_vector.i library.
215215
<li> The $ operator is used for method access.
216-
<li> Variable accessors are automatically generated and called via the $, [, [[, $&lt;-, [&lt;-, [[&lt;- operators
216+
<li> Variable accessors are automatically generated and called via the $, [, [[, $&lt;-, [&lt;-, [[&lt;- operators.
217217
</ul>
218218
</p>
219219

220220
<H3><a name="R_class_examples">34.6.1 Examples</a></H3>
221221

222222

223+
<p>
223224
Consider the following simple example:
225+
</p>
224226

225227
<div class="code">
226228
<pre>
227229
class Vehicle {
228230
private:
229231
int m_axles;
232+
230233
public:
231234
int Axles() {
232235
return(m_axles);
233236
}
237+
234238
bool Available;
235239

236240
Vehicle() {
@@ -246,12 +250,14 @@ <H3><a name="R_class_examples">34.6.1 Examples</a></H3>
246250
</pre>
247251
</div>
248252

253+
<p>
249254
The following options are available in R:
255+
</p>
250256

251257
<div class="code">
252-
<pre>
253-
v1 &lt- Vehicle()
254-
v2 &lt- Vehicle(4)
258+
<pre>
259+
v1 &lt;- Vehicle()
260+
v2 &lt;- Vehicle(4)
255261
# access members
256262
v1$Axles()
257263
[1] 2
@@ -260,7 +266,7 @@ <H3><a name="R_class_examples">34.6.1 Examples</a></H3>
260266
v1$Available
261267
[1] FALSE
262268
# Set availabilty
263-
v1$Available &lt- TRUE
269+
v1$Available &lt;- TRUE
264270
v1$Available
265271
[1] TRUE
266272
</pre>
@@ -302,7 +308,7 @@ <H3><a name="R_class_examples">34.6.1 Examples</a></H3>
302308
</pre>
303309
</div>
304310
<p>
305-
The names in the accessorFuns list correspond to class methods while names in the vaccessors section
311+
The names in the <tt>accessorFuns</tt> list correspond to class methods while names in the <tt>vaccessors</tt> section
306312
correspond to variables that may be modified.
307313
</p>
308314
<H2><a name="R_nn7">34.7 Enumerations</a></H2>

0 commit comments

Comments
 (0)