[Rd] PR#1132.

rolf@math.unb.ca rolf@math.unb.ca
Thu, 4 Apr 2002 18:26:47 +0200 (MET DST)


Just now I again had occasion to want nested describe lists in a
documentation file.  I found that the bug which I reported on 18
October, 2001 still persists.  I checked on the bug report at the R
web page, and found that the notes say ``Not a problem in R 1.4.0
(2001-12-08)''.

Well, it's still a problem for me --- using R 1.4.1.

(Details:

platform sparc-sun-solaris2.7
arch     sparc               
os       solaris2.7          
system   sparc, solaris2.7   
status                       
major    1                   
minor    4.1                 
year     2002                
month    01                  
day      30                  
language R ).

I executed

	R CMD Rdconv -t=htlm foo.Rd > foo.html

where foo.Rd is the example documentation file that I submitted to
illustrate the bug.  On my system, the bug remains.  I.e. the nested
describes screw up.   The item in the outer describe list, just
before the inner describe list, (in the example ``fred'') gets
omitted, along with the first couple of items of the inner describe
list.  The third item of the inner describe list seems to get treated
as if it were an element of the outer list, and gets jumbled with a
bit of the ``fred'' item.

I enclose below the file foo.html that I got on my system.

Could you please check to see if the same thing happens when you run
the Rdconv command on your system?  I guess it's possible that
there's a local glitch here (e.g. something wrong with perl?) that
causes the screw-up.

					cheers,

						Rolf Turner
						rolf@math.unb.ca

===+===+===+===+===+===+===+===+===+===+===+===+===+===+===+===+===+===+===

File foo.html:
==============

<html><head><title>R: Do nothing.</title>
<link rel="stylesheet" type="text/css" href="../../R.css">
</head><body>


<h2>Do nothing.</h2>


<h3>Description</h3>

<p>
Do nothing, but do it <b>very</b> well!
</p>


<h3>Usage</h3>

<pre>
foo(gorp,par)
</pre>


<h3>Arguments</h3>

<table summary="R argblock">
<tr valign="top"><td><code>gorp</code></td>
<td>
I don't know either.</td></tr>
<tr valign="top"><td><code>par</code></td>
<td>
Never you mind!</td></tr>
</table>

<h3>Details</h3>

<p>
The parameter list <code>par</code> should be
as follows, for each possible value of <code>gorp</code>:
<dl>
<dt>melvin:</dt><dd>(Melvin Mingdinkler.) A vector with components
<i>(beta,gamma,r)</i> which are respectively
a load of dingos' kidneys, an elephant, and a duck.
Note that <i>gamma</i> must be totally ridiculuous.
</dd>


<dt>clyde:</dt><dd>(Clyde, clyde, the cow's outside.) A vector with
entries <i>(beta,gamma,r_0,r)</i> where
<i>beta</i>, <i>gamma</i>, and <i>r</i> are as for
<code>melvin</code>, <i>r_0</i> is a hippopotamus.  Of course
<i>r_0</i> must eat less than <i>r</i>.
</dd>


<dt>irving:</dt><dd>(The 142nd fastest gun in the West.) A vector
with components <i>(beta,sigma,kappa)</i>.
Again <i>beta</i> is a load of dingos' kidneys.
The difference between a duck is
</p><p align="center"><i>(sigma/kappa)^2</i></p><p>
Note that it is necessary that <i>kappa &gt; 42</i>.
</dd>


<dt>r:</dt><dd>A <b>symmetric</b> matrix of ducks with
<i>r_ij</i> pertaining to the kidneys of dingo
<i>i</i> and dingo <i>j</i>.</dd><dd>(Fred Nurk.) Here <code>par</code> is
given as a list with components
</p>

<dl>
<dt>beta:</dt><dd>A vector of loads of dingos' kidneys.</dd>
<dt>gamma:</dt><dd>A <b>symmetric</b> matrix of elephants,
with <i>gamma_ij</i> pertaining to the kidneys of
dingo <i>i</i> and dingo <i>j</i>.</dd>


<dt>r:</dt><dd>A <b>symmetric</b> matrix of ducks with
<i>r_ij</i> pertaining to the kidneys of dingo
<i>i</i> and dingo <i>j</i>.</dd>
</dl></dd>
</dl>

<h3>Warnings</h3>

<p>
Even paranoids have real enemies.
</p>


<h3>Author(s)</h3>

<p>
Rolf Turner
<a href="mailto:rolf@math.unb.ca">rolf@math.unb.ca</a>
<a href="http://www.math.unb.ca/~rolf">http://www.math.unb.ca/~rolf</a>
</p>


<h3>References</h3>

<p>
Gates, V. ``42 Wonderful Things to do in Come-by-Chance, Nfld.'',
Memorial University Press, St. John's Nfld., 2001.
</p>
<p>
Ye-of-little-faith, O.  ``An annotated bibliography of green
peas and their ilk'', Journal of the Hopeless, vol. 42, 1950,
pp.  101 &#150; 64.
</p>


<h3>See Also</h3>

<p>
<code><a href="../../../doc/html/search/SearchObject.html?bar">bar</a></code>,
<code><a href="../../../doc/html/search/SearchObject.html?snafu">snafu</a></code>,
</p>


<h3>Examples</h3>

<pre>
   #Oh come on!  You can think up your own examples!
   </pre>



<hr><div align="center"><a href="00Index.html">[Package Contents]</a></div>

</body></html>

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._