[R-gregmisc-users] SF.net SVN: r-gregmisc:[2015] trunk/gtools/man/unByteCode.Rd

[<wa...@us...>]

Revision: 2015
          http://sourceforge.net/p/r-gregmisc/code/2015
Author:   warnes
Date:     2015-05-02 13:47:47 +0000 (Sat, 02 May 2015)
Log Message:
-----------
Add man page for unByteCode(), assignEdgeWise(), and unByteCodeAssign()

Added Paths:
-----------
    trunk/gtools/man/unByteCode.Rd

Added: trunk/gtools/man/unByteCode.Rd
===================================================================
--- trunk/gtools/man/unByteCode.Rd	                        (rev 0)
+++ trunk/gtools/man/unByteCode.Rd	2015-05-02 13:47:47 UTC (rev 2015)
@@ -0,0 +1,82 @@
+\name{unByteCode}
+\alias{unByteCode}
+\alias{unByteCodeAssign}
+\alias{assignEdgeWise}
+\title{
+  Convert a Byte-Code Function to an Interpreted-Code Function
+}
+\description{
+  Convert a byte-code function to an interpreted-code function
+}
+\usage{
+unByteCode(fun)
+assignEdgewise(name, env, value)
+unByteCodeAssign(fun)
+}
+\arguments{
+  \item{fun}{function to be modified}
+  \item{env}{namespace}
+  \item{value}{new function body}
+}
+\details{
+  The purpose of these functions is to allow a byte coded function to be
+  converted back into a fully interpreted function as a \emph{temporary}
+  work around for issues in byte-code interpretation.
+
+  \code{unByteCode} returns a copy of the function that is directly interpreted
+  from text rather than from byte-code.
+
+  \code{assignEdgewise} makes an assignment into a locked environemnt.
+
+  \code{unByteCodeAssign} changes the specified function \emph{in its source
+  environment} to be directly interpreted from text rather than from byte-code.
+}
+\value{
+  All three functions return a copy of the modified function or assigned value.
+}
+\references{
+  These functions were inspired as a work-around to R bug
+  \url{https://bugs.r-project.org/bugzilla/show_bug.cgi?id=15215}.
+}
+\author{
+  Gregory R. Warnes \email{gr...@wa...}
+}
+\note{
+  These functions are not intended as a permanent solution to issues
+  with byte-code compilation or interpretation.  Any such issues should
+  be promtply reported to the R maintainers via the R Bug Tracking
+  System at \url{https://bugs.r-project.org} and via the R-devel
+  mailing list \url{https://stat.ethz.ch/mailman/listinfo/r-devel}.
+}
+\seealso{
+  \code{\link[compiler]{disassemble}},
+  \code{\link{assign}}
+}
+\examples{
+datURL <- "https://bugs.r-project.org/bugzilla/attachment.cgi?id=1659"
+dat <- as.matrix(read.csv(file=datURL, row.names=1))
+dist2 <- function(x) as.dist(1-cor(t(x), method="pearson"))
+hclust1 <- function(x) hclust(x, method = "single")
+
+distance <- dist2(dat)
+cluster  <- hclust1(distance)
+
+dend <- as.dendrogram(cluster)
+
+\dontrun{
+    ## In R 2.3.0 and earlier crashes R: with a node stack overflow error
+    plot(dend)
+    ## Error in xy.coords(x, y, recycle = TRUE) : node stack overflow
+}
+
+## convert stats:::plotNode from byte-code to interpreted-code
+unByteCodeAssign(stats:::plotNode)
+
+# increase recursion limit
+options("expressions"=5e4)
+
+# now the function does not crash
+plot(dend)
+}
+\keyword{programming}
+\keyword{utilites}

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.