[Distr-commits] r496 - in pkg/SweaveListingUtils: chm inst
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Thu Jul 2 00:59:35 CEST 2009
Author: ruckdeschel
Date: 2009-07-02 00:59:33 +0200 (Thu, 02 Jul 2009)
New Revision: 496
Modified:
pkg/SweaveListingUtils/chm/00Index.html
pkg/SweaveListingUtils/chm/0SweaveListingUtils-package.html
pkg/SweaveListingUtils/chm/SweaveListingOptions.html
pkg/SweaveListingUtils/chm/SweaveListingPreparations.html
pkg/SweaveListingUtils/chm/SweaveListingUtils.chm
pkg/SweaveListingUtils/chm/copySourceFromRForge.html
pkg/SweaveListingUtils/chm/library.html
pkg/SweaveListingUtils/chm/lstinputSourceFromRForge.html
pkg/SweaveListingUtils/chm/readSourceFromRForge.html
pkg/SweaveListingUtils/inst/MASKING
pkg/SweaveListingUtils/inst/NEWS
Log:
updated MASKING and NEWS entries in SweaveListingUtils
Modified: pkg/SweaveListingUtils/chm/00Index.html
===================================================================
--- pkg/SweaveListingUtils/chm/00Index.html 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/chm/00Index.html 2009-07-01 22:59:33 UTC (rev 496)
@@ -10,7 +10,7 @@
<param name="keyword" value=".. contents">
</object>
-<h2>Help pages for package ‘SweaveListingUtils’ version 0.2.3</h2>
+<h2>Help pages for package ‘SweaveListingUtils’ version 0.3</h2>
<table width="100%">
<tr><td width="25%"><a href="0SweaveListingUtils-package.html">SweaveListingUtils-package</a></td>
Modified: pkg/SweaveListingUtils/chm/0SweaveListingUtils-package.html
===================================================================
--- pkg/SweaveListingUtils/chm/0SweaveListingUtils-package.html 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/chm/0SweaveListingUtils-package.html 2009-07-01 22:59:33 UTC (rev 496)
@@ -33,10 +33,10 @@
<td align="left">Package: </td> <td align="left"> SweaveListingUtils</td>
</tr>
<tr>
- <td align="left"> Version: </td> <td align="left"> 0.2 </td>
+ <td align="left"> Version: </td> <td align="left"> 0.3</td>
</tr>
<tr>
- <td align="left"> Date: </td> <td align="left"> 2008-11-27 </td>
+ <td align="left"> Date: </td> <td align="left"> 2009-03-19</td>
</tr>
<tr>
<td align="left"> Depends: </td> <td align="left"> R(>= 2.0.0), startupmsg</td>
@@ -76,7 +76,8 @@
</p>
<p>
For a corresponding TeX preamble combining Sweave and ‘<span class="file">listings</span>’,
-we provide command <code><a href="SweaveListingPreparations.html">SweaveListingPreparations</a></code>.
+we provide command <br>
+<code><a href="SweaveListingPreparations.html">SweaveListingPreparations</a></code>.
</p>
<p>
As for the <font face="Courier New,Courier" color="#666666"><b>R</b></font> language definition, we allow for different keywordstyles
@@ -172,6 +173,6 @@
-<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.2 <a href="00Index.html">Index]</a></div>
+<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.3 <a href="00Index.html">Index</a>]</div>
</body></html>
Modified: pkg/SweaveListingUtils/chm/SweaveListingOptions.html
===================================================================
--- pkg/SweaveListingUtils/chm/SweaveListingOptions.html 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/chm/SweaveListingOptions.html 2009-07-01 22:59:33 UTC (rev 496)
@@ -84,12 +84,14 @@
<code> "commentstyle" = "{\\color{Rcomment}\\ttfamily\\itshape}",</code><br>
<code> "literate" = "{<-}{{$\\leftarrow$}}2{<<-}{{$\\twoheadleftarrow$}}2",</code><br>
<code> "alsoother" = "{$}","alsoletter" = "{.<-}"</code><br>
+<code> "otherkeywords" = </code>
<code> "otherkeywords" = "{!,!=,~,$,*,\\&,\\ %/\\ %,\\ %*\\ %,\\ %\\ %,<-,<<-,/}")</code><br>
-(CAVEAT: the spaces between the double backslashes and the percent sign in the last line
+(CAVEAT: the spaces between the double backslashes and the percent sign in the last line
are <EM>not</EM> intended; I simply did not find another work-around)
</dd>
<dt>Rdset:</dt><dd>default setting for \lstset-definition of Rd-code, default value is<br>
-<code>list("fancyvrb" = "true", "language" = "Rd", "basicstyle" = "{\\color{black}\\tiny}",</code><br>
+<code>list("fancyvrb" = "true", "language" = "Rd",</code><br>
+<code> "basicstyle" = "{\\color{black}\\tiny}",</code><br>
<code> "keywordstyle" = "{\\bf}",</code><br>
<code> "commentstyle" = "\\ttfamily\\itshape",</code><br>
<code> "alsolanguage" = "R")</code>
@@ -122,7 +124,7 @@
"r-forge.r-project.org" (or a mirror) or not; defaults to
<code>TRUE</code>.</dd>
<dt>base.url:</dt><dd>default setting for the base url to download code sniplets from
-(character); defaults to
+(character); defaults to<br>
"http://r-forge.r-project.org/plugins/scmsvn/viewcvs.php/*checkout*/pkg/"
</dd>
@@ -165,6 +167,6 @@
</script>
-<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.2 <a href="00Index.html">Index]</a></div>
+<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.3 <a href="00Index.html">Index</a>]</div>
</body></html>
Modified: pkg/SweaveListingUtils/chm/SweaveListingPreparations.html
===================================================================
--- pkg/SweaveListingUtils/chm/SweaveListingPreparations.html 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/chm/SweaveListingPreparations.html 2009-07-01 22:59:33 UTC (rev 496)
@@ -24,7 +24,12 @@
<h3>Usage</h3>
<pre>
-SweaveListingPreparations(LineLength = 80,
+SweaveListingPreparations(
+ withOwnFileSection = FALSE,
+ withVerbatim = FALSE,
+ gin = TRUE,
+ ae = TRUE,
+ LineLength = 80,
Rset = getSweaveListingOption("Rset"),
Rdset = getSweaveListingOption("Rdset"),
Rcolor = getSweaveListingOption("Rcolor"),
@@ -40,6 +45,33 @@
<h3>Arguments</h3>
<table summary="R argblock">
+<tr valign="top"><td><code>withOwnFileSection</code></td>
+<td>
+logical: Does one want to use an own definition file/
+section to define <code>Sinput</code>, <code>Soutput</code>,
+<code>Scode</code> environments; if <code>TRUE</code> you should write some
+<KBD>\include</KBD> directive to include your own
+definitions / or write them in your ‘<span class="file">.Rnw</span>’ file.
+</td></tr>
+<tr valign="top"><td><code>withVerbatim</code></td>
+<td>
+logical of length 3 (filled by recycling if of shorter length)
+either named ("Sinput", "Soutput", "Scode") or taken in
+order (Sinput, Soutput, Scode):
+Should we use Verbatim from TeX package 'fancyvrb'
+(i.e. the original
+<KBD>"\DefineVerbatimEnvironment{Sinput}{Verbatim}"</KBD> by
+Fritz Leisch) or just TeX package 'listings'
+(i.e. we define our own <code>Sinput</code> environment
+based on 'listings' command 'lstnewenvironment';
+this option is due to a suggestion by
+Andrew Ellis (thank you!).</td></tr>
+<tr valign="top"><td><code>gin</code></td>
+<td>
+logical: shall we use <code>gin</code></td></tr>
+<tr valign="top"><td><code>ae</code></td>
+<td>
+logical: shall we use <code>ae</code></td></tr>
<tr valign="top"><td><code>LineLength</code></td>
<td>
numeric; defaults to 80</td></tr>
@@ -127,6 +159,14 @@
<p>
<code>invisible()</code></p>
+<h3>Acknowledgement</h3>
+
+<p>
+The author wants to thank Frank E. Harrel and Andrew Ellis for
+very valuable suggestions to enhance this package.
+</p>
+
+
<h3>Author(s)</h3>
<p>
@@ -143,6 +183,6 @@
-<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.2 <a href="00Index.html">Index]</a></div>
+<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.3 <a href="00Index.html">Index</a>]</div>
</body></html>
Modified: pkg/SweaveListingUtils/chm/SweaveListingUtils.chm
===================================================================
(Binary files differ)
Modified: pkg/SweaveListingUtils/chm/copySourceFromRForge.html
===================================================================
--- pkg/SweaveListingUtils/chm/copySourceFromRForge.html 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/chm/copySourceFromRForge.html 2009-07-01 22:59:33 UTC (rev 496)
@@ -25,9 +25,9 @@
<pre>
copySourceFromRForge(PKG, TYPE, FILENAME, PROJECT, from, to,
- offset.before = 0, offset.after = 0,
- fromRForge = getSweaveListingOption("fromRForge"),
- base.url = getSweaveListingOption("base.url") )
+ offset.before = 0, offset.after = 0,
+ fromRForge = getSweaveListingOption("fromRForge"),
+ base.url = getSweaveListingOption("base.url") )
</pre>
@@ -127,6 +127,6 @@
</script>
-<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.2 <a href="00Index.html">Index]</a></div>
+<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.3 <a href="00Index.html">Index</a>]</div>
</body></html>
Modified: pkg/SweaveListingUtils/chm/library.html
===================================================================
--- pkg/SweaveListingUtils/chm/library.html 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/chm/library.html 2009-07-01 22:59:33 UTC (rev 496)
@@ -49,7 +49,7 @@
<table summary="R argblock">
<tr valign="top"><td><code>package, help</code></td>
<td>
-the name of a package, given as a <a href="onclick="findlink('base', 'name.html')" style="text-decoration: underline; color: blue; cursor: hand"">name</a> or
+the name of a package, given as a <a href="onclick="findlink('distrTEst', 'name-methods.html')" style="text-decoration: underline; color: blue; cursor: hand"">name</a> or
literal character string, or a character string, depending on
whether <code>character.only</code> is <code>FALSE</code> (default) or
<code>TRUE</code>).</td></tr>
@@ -91,7 +91,7 @@
<td>
logical. If <code>TRUE</code>, functions
‘keep their source’ including comments, see argument
-<code>keep.source</code> to <code><a onclick="findlink('base', 'options.html')" style="text-decoration: underline; color: blue; cursor: hand">options</a></code>. This applies only to
+<code>keep.source</code> to <code><a onclick="findlink('distr', 'options.html')" style="text-decoration: underline; color: blue; cursor: hand">options</a></code>. This applies only to
the named package, and not to any packages or name spaces which might be
loaded to satisfy dependencies or imports.
<br>
@@ -223,6 +223,14 @@
require(distr)
@
</pre>
+In order to unmask the original versions of <code>library</code> and <code>require</code>
+again after Sweave-ing your <code>.Rnw</code> file, at the end of your <code>.Rnw</code>
+file you should include an Sweave chunk like
+<pre>
+<<cleanup, echo=FALSE>>=
+unloadNamespace("SweaveListingUtils")
+@
+</pre>
</p>
@@ -255,6 +263,6 @@
</script>
-<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.2 <a href="00Index.html">Index]</a></div>
+<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.3 <a href="00Index.html">Index</a>]</div>
</body></html>
Modified: pkg/SweaveListingUtils/chm/lstinputSourceFromRForge.html
===================================================================
--- pkg/SweaveListingUtils/chm/lstinputSourceFromRForge.html 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/chm/lstinputSourceFromRForge.html 2009-07-01 22:59:33 UTC (rev 496)
@@ -25,11 +25,11 @@
<pre>
lstinputSourceFromRForge(PKG, TYPE, FILENAME, PROJECT, from, to,
- offset.before = 0, offset.after = 0,
- LineLength = 80,
- withLines = ifelse(TYPE=="R", TRUE, FALSE),
- fromRForge = getSweaveListingOption("fromRForge"),
- base.url = getSweaveListingOption("base.url"))
+ offset.before = 0, offset.after = 0,
+ LineLength = 80,
+ withLines = ifelse(TYPE=="R", TRUE, FALSE),
+ fromRForge = getSweaveListingOption("fromRForge"),
+ base.url = getSweaveListingOption("base.url"))
</pre>
@@ -152,6 +152,6 @@
-<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.2 <a href="00Index.html">Index]</a></div>
+<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.3 <a href="00Index.html">Index</a>]</div>
</body></html>
Modified: pkg/SweaveListingUtils/chm/readSourceFromRForge.html
===================================================================
--- pkg/SweaveListingUtils/chm/readSourceFromRForge.html 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/chm/readSourceFromRForge.html 2009-07-01 22:59:33 UTC (rev 496)
@@ -25,8 +25,8 @@
<pre>
readSourceFromRForge(PKG, TYPE, FILENAME, PROJECT,
- fromRForge = getSweaveListingOption("fromRForge"),
- base.url = getSweaveListingOption("base.url"))
+ fromRForge = getSweaveListingOption("fromRForge"),
+ base.url = getSweaveListingOption("base.url"))
</pre>
@@ -86,6 +86,6 @@
-<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.2 <a href="00Index.html">Index]</a></div>
+<hr><div align="center">[Package <em>SweaveListingUtils</em> version 0.3 <a href="00Index.html">Index</a>]</div>
</body></html>
Modified: pkg/SweaveListingUtils/inst/MASKING
===================================================================
--- pkg/SweaveListingUtils/inst/MASKING 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/inst/MASKING 2009-07-01 22:59:33 UTC (rev 496)
@@ -11,10 +11,19 @@
with TeX package 'listings' with the possibility to "tune" the
corresponding keywordstyle for both the package required/"library"-ed
and respective intermediate packages loaded/attached automatically,
-we intentionally base functions 'library' and 'require' --- however
-all these functions may still be used in exactly the same way as
-before masking.
+we intentionally mask base functions 'library' and 'require' ---
+however all these functions may still be used in exactly the same
+way as before masking.
+Still, for completely returning to the usual behaviour (i.e.; stop
+issuing TeX code for registering new keywords) and unmasking
+the original versions of 'library' and 'require', at the end of
+your .Rnw file, you should include an Sweave chunk like
+
+<<cleanup, echo=FALSE>>=
+unloadNamespace("SweaveListingUtils")
+@
+
*** non-intentional masking: ***
... nothing discovered so far ...
\ No newline at end of file
Modified: pkg/SweaveListingUtils/inst/NEWS
===================================================================
--- pkg/SweaveListingUtils/inst/NEWS 2009-07-01 20:25:09 UTC (rev 495)
+++ pkg/SweaveListingUtils/inst/NEWS 2009-07-01 22:59:33 UTC (rev 496)
@@ -3,6 +3,30 @@
######################################################################
##############
+v 0.3
+##############
+
+* included some suggestions due to Frank E. Harrel as to the
+ default settings of R markup (in particular as to "literate
+ programming")
+* included some description/documentation how to re-unmask
+ base functions 'library' and 'require' at the end of
+ an .Rnw file
+* Rd-Style Markup
+ +updated Rdlisting.sty according to the new version of
+ "Parsing Rd Files" by Duncan Murdoch as of Jun 21 2009
+* thanks to Andrew Ellis:
+ new options for SweaveListingPreparations:
+ + withOwnFileSection in order to allow for own definition file/
+ section to define 'Sinput', 'Soutput',
+ 'Scode' environments
+ + withVerbatim in order to allow to use 'lstnewenvironment' - type
+ environments for 'Sinput', 'Soutput', 'Scode' instead of
+ the Sweave.sty-default with \DefineVerbatimEnvironment.
+ this in particular allows for escaping mechanisms
+ as provided for in 'listings' package
+
+##############
v 0.2
##############
More information about the Distr-commits
mailing list