similar to: Go (back) from Rd to roxygen

Hi, A new package Rd2roxygen has been released on CRAN: http://cran.r-project.org/package=Rd2roxygen (source package available; binaries to come) This package can be useful for developers who used to document their functions in the raw Rd files but want to switch to roxygen now using inline roxygen comments (e.g. me). The main functionality of this package is to parse the Rd files under the

Hi all, It seems roxygen will create Rd files for any functions under the ./R/ directory, and I did not find a way to hide certain functions, even if I specified a name space. E.g. #' @export f = function() {} #' do nothing g = function() {} If I run roxygenize() on the package, both f and g will be documented, although only f is visible to the users. Thanks! Regards, Yihui -- Yihui

Hi, A new version (0.1-5) of Rd2roxygen is on CRAN now. Rd2roxygen is a package to help developers transit from the raw Rd files to roxygen-style documentations, and it also has utilities to help build the package (with options to reformat the usage and examples sections). Updates: ?o a new way to reformat the usage and examples sections generated by roxygen; it is more reliable than earlier

Hi, A new version (0.1-5) of Rd2roxygen is on CRAN now. Rd2roxygen is a package to help developers transit from the raw Rd files to roxygen-style documentations, and it also has utilities to help build the package (with options to reformat the usage and examples sections). Updates: ?o a new way to reformat the usage and examples sections generated by roxygen; it is more reliable than earlier

While checking packages against R 2.13.0-beta on Windows, I have run into a few strange error messages related to copying files. The errors all relate to file.copy() and have the form of: Error in Sys.chmod(to[okay], file.info(from[okay])$mode, TRUE) : 'mode' must be of length at least one After half a day of tinkering, the best reproducible example I can come up with involves using

Hi, I have a function knit_expand() and its source/Rd are below: https://github.com/yihui/knitr/blob/master/R/template.R#L43-L44 https://github.com/yihui/knitr/blob/master/man/knit_expand.Rd When I run R CMD check on the package I get this warning (with both R 2.15.2 and R-devel): * checking for code/documentation mismatches ... WARNING Codoc mismatches from documentation object

Dear list, somehow I can't get the Roxygen tag "@example" to work for me. My "Roxygen-Header" of a script containing, say, a function looks like this: #' My header #' #' My description #' #' @param a Blabla. #' @param b Blabla. #' @return \code{TRUE}. #' @callGraphPrimitives #' @references #'

Almost all of the coxme package and an increasing amount of the survival package are now written in noweb, i.e., .Rnw files. It would be nice to process these using the Sweave function + a special driver, which I can do using a modified version of Sweave. The primary change is to allow the following type of construction <<coxme>> coxme <- function(formula, data, subset, blah blah

R-helpers: Are there any ways to auto-generate R-friendly (e.g. will pass a compilation check) .Rd files given a set of .R code? How about GUIs that help properly format the .Rd files? Thanks! I want a basic set of .Rd files that I can update as I go, but as with most things my documentation typically lags behind my coding by a few days. --j -- Jonathan A. Greenberg, PhD Assistant Project

Hi, I have spent a few hours on the R-exts manual and the documentation of parse_Rd() (as well as the PDF document in the references), but I still have not figured out what results=rd means. I thought I could use an R code fragment to create an Rd fragment dynamically. Here is an example, in which I was expected the output to be a describe list <DL> in HTML, but it turns out not to be true.

Hi, Recently I noticed file.copy() would discard the file mode information. Is this the expected behaviour or a bug for file.copy()? > file.create('testfile') [1] TRUE > file.info('testfile') size isdir mode mtime ctime testfile 0 FALSE 644 2011-03-05 17:06:39 2011-03-05 17:06:39 atime uid gid uname grname

Hi, Recently I noticed file.copy() would discard the file mode information. Is this the expected behaviour or a bug for file.copy()? > file.create('testfile') [1] TRUE > file.info('testfile') size isdir mode mtime ctime testfile 0 FALSE 644 2011-03-05 17:06:39 2011-03-05 17:06:39 atime uid gid uname grname

Hi, Suppose I have x = parse(text = " {y=50+50+50#'asfasf' } ") now x is an expression with some src attributes. > x expression({y=50+50+50#'asfasf' }) attr(,"srcfile") <text> attr(,"wholeSrcref") {y=50+50+50#'asfasf' } My question is, how can I get my string back (the string passed to parse() as the text argument)? >

Hi, The problem arises when I lazyLoad() the .Random.seed from a previously saved database. To simplify the process of reproducing the problem, see the example below: ## this assignment may not really make sense, but illustrates the problem delayedAssign('.Random.seed', 1L) typeof(.Random.seed) # [1] "integer" rnorm(1) # Error in rnorm(1) : # .Random.seed is not an integer

Hi, The problem arises when I lazyLoad() the .Random.seed from a previously saved database. To simplify the process of reproducing the problem, see the example below: ## this assignment may not really make sense, but illustrates the problem delayedAssign('.Random.seed', 1L) typeof(.Random.seed) # [1] "integer" rnorm(1) # Error in rnorm(1) : # .Random.seed is not an integer

Hi is there a list of all roxygen tags which are available? I couldn't find them. I am asking specifically towards the use of roxygen in documenting S4 classes - is that implemented yet (i am using roxygen 0.1 from CRAN at the moment)? Thanks Rainer -- Rainer M. Krug, Centre of Excellence for Invasion Biology, Stellenbosch University, South Africa

I have Vista Home with R-2.9.0, and installed and tried to test the package 'roxygen': > utils:::menuInstallPkgs() trying URL 'http://lib.stat.cmu.edu/R/CRAN/bin/windows/contrib/2.9/roxygen_0.1.zip' Content type 'application/zip' length 699474 bytes (683 Kb) opened URL downloaded 683 Kb package 'roxygen' successfully unpacked and MD5 sums checked The

Hi, A Windows user asked me a question and I believe this is a bug of R 3.0.0 under Windows: > plot(1:10) > savePlot('test.wmf') Error in .External(C_savePlot, device, filename, type, restoreConsole) : Incorrect number of arguments (4), expecting 3 for 'savePlot' > sessionInfo() R version 3.0.0 (2013-04-03) Platform: x86_64-w64-mingw32/x64 (64-bit) locale: [1]

Hi, I observed a slight problem in deparse(): it will add spaces around most operators except /. I wonder if this is easy to fix. I know this is quite trivial, but I will appreciate if / is not treated as an exception. Examples: > deparse(expression(1/1)) [1] "expression(1/1)" > deparse(expression(1+1)) [1] "expression(1 + 1)" > deparse(expression(1%in%1)) [1]

Hi, I'm aware of the definition of a "valid filename" in .SweaveValidFilenameRegexp, but I think it might be better to quote the filename when it contains spaces instead of just giving a warning. This should bring us safer LaTeX code (although I never use spaces in paths). Here is the simple patch: Index: src/library/utils/R/SweaveDrivers.R