search for: roxygenize

> -----Urspr?ngliche Nachricht----- > Von: roxygen-devel-bounces at lists.r-forge.r-project.org [mailto:roxygen- > devel-bounces at lists.r-forge.r-project.org] Im Auftrag von Vinh Nguyen > Gesendet: Donnerstag, 4. November 2010 04:04 > An: roxygen-devel at r-forge.wu-wien.ac.at > Betreff: Re: [Roxygen-devel] Roxygen: @example tag does not work for me > > Try @examples

Hi, I have been using R for a while. Recently, I have begun converting my package into S4 classes. I was previously using Rdoc for documentation. Now, I am looking to use the best tool for S4 documentation. It seems that the best choices for me are Roxygen and Sweave (I am fine with tex). Are there any users of Roxygen or Sweave who can comment on the strengths or weaknesses of one or othe

...gt; > Duncan Murdoch > > This has been submitted as an issue at https://github.com/klutometis/roxygen/issues/378 closely related: https://github.com/klutometis/roxygen/issues/371 my current hacky solution to this is to use a Makefile that post-processes the NAMESPACE after it's roxygenized, e.g. search for "getRversion" in https://github.com/glmmTMB/glmmTMB/blob/master/Makefile

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

...o use the Roxygen package. Here my code file : #' A packge to check Roxygen's sanity #' @name helloRoxygen-package #' @docType package NA And my R code to generate the package : library(roxygen) package.skeleton("helloRoxygen", code_files = "roxy.r", force = T) roxygenize("helloRoxygen", "helloRoxygen", copy.package = F, unlink.target = F, overwrite = T) I obtain this error message : Writing helloRoxygen-package to helloRoxygen/man/helloRoxygen-package.Rd Writing namespace directives to helloRoxygen/NAMESPACE Merging collate directive with hello...

On 30/01/2018 11:29 AM, Brian G. Peterson wrote: > On Tue, 2018-01-30 at 17:00 +0100, Suzen, Mehmet wrote: >> Dear R developers, >> >> I am wondering what are the best practices for developing an R >> package. I am aware of Hadley Wickham's best practice >> documentation/book (http://r-pkgs.had.co.nz/).??I recall a couple of >> years ago there were some

...es for the tikzDevice: # Install roxygen from CRAN and grab tikzDevice source code R --vanilla --slave -e "install.packages('roxygen')" git clone git://github.com/Sharpie/RTikZDevice.git # Generate documentation, first run succeeds: R --vanilla --slave -e "require(roxygen); roxygenize('RTikZDevice', 'RTikZDevice.build', overwrite = TRUE)" Loading required package: roxygen Loading required package: digest Writing anyMultibyteUTF8Characters to RTikZDevice.copy/man/anyMultibyteUTF8Characters.Rd Warning in parse.name(partitum) : No name found for the followin...

Any way to tell Roxygen to ignore a block of code? It is generating an unwanted .Rd file. I've been searching for hours for an example, scouring documentation, but no luck... Thanks. - Ken -- View this message in context: http://www.nabble.com/Roxygen-to-ignore-a-block-of-code--tp24133293p24133293.html Sent from the R help mailing list archive at Nabble.com.

...unction}} Foo <- function(a, b){cat("Doing nothing useful.")} I thought that @example would take the R code in "tests/foo.R" (this file also exists) and append it to the .Rd-file. However, there is no \examples{...} section in my roxygen-processed .Rd-file after running roxygenize(). It just seems as if @example is just neglected. Should I put the file in another directory? The basic thing I'm trying to do is to have the "unit tests" for my functions organized in separate scripts and then plug in some of their content as examples in the .Rd-files (this sho...

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 all, Since roxygen is a great help to document R packages, I am wondering if there exists an approach to go back from the raw Rd files to roxygen-documentation? E.g. turn "\author{Somebody}" into "@author Somebody". This sounds ridiculous, but I believe it helps in the long term for me to maintain R packages. Thanks! Regards, Yihui -- Yihui Xie <xieyihui at

...Code for my package into the following scripts: classes.R (S4), functions.R ('standard' functions), generics.R (S4), methods.R (S4). Function package.skeleton() generates Rd-files for all class defs, function defs etc. in dir 'pkg/man'. So far, so good. Now, I'd like to run 'roxygenize()' on dir 'pkg' and face the problem that the argument 'use.Rd2' only works for parts of the Rd-files, no matter how it is specified. Setting it FALSE works for all non-S4 defs, setting it TRUE works for all S4-defs ('works' in the sense of ending up with non-empty \titl...

...s been submitted as an issue at > > https://github.com/klutometis/roxygen/issues/378 > > closely related: > > https://github.com/klutometis/roxygen/issues/371 > > my current hacky solution to this is to use a Makefile that > post-processes the NAMESPACE after it's roxygenized, e.g. search > for "getRversion" in > > https://github.com/glmmTMB/glmmTMB/blob/master/Makefile Hadley has the right idea (allow roxygen to specify some uninterpreted text to drop into the NAMESPACE file), but it doesn't go far enough. Really this is a design flaw in roxyg...

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

Is there any interest in a method of taking a package with documentation in Rd files and attaching it to package R files in Roxygen format? I can see a few problems with a totally general solution but it might be possible to make a script that provides a kickstart to converting a package to Roxygen. Or is it trickier than it seems? Barry

> >> I am wondering what are the best practices for developing an R > >> package. I am aware of Hadley Wickham's best practice > >> documentation/book (http://r-pkgs.had.co.nz/).??I recall a couple of > >> years ago there were some tools for generating a package out of a > >> single file, such as using package.skeleton, but no auto-generated

Hi, I am getting a strange error with 15.0 which I've not seen with previous versions of R. If sysdata.rda is included in R directory of the package I am getting: R CMD build betfairly.roxygen/ * checking for file ?betfairly.roxygen/DESCRIPTION? ... OK * preparing ?betfairly?: * checking DESCRIPTION meta-information ... OK * excluding invalid files Subdirectory 'R' contains invalid

Dear list, I have just started to use roxygen and cannot find out how to specify NOT RUN examples. I know that to include R code examples works via the @examples tag followed by the code. Without roxygen, if I want R code not to be run when processing the .Rd files I would include the \dontrun tag \examples{\dontrun{ ... some example R code} } How can I achieve this using roxygen? Thanks Mark

I am modifying a package that appears to have been made with roxygen. I'm currently running Debian stable (wheezy) amd64 with the stock R 2.15.1. I have some other, mostly older, flavors as well. roxygen doesn't seem to be in the Debian repositories or (if I wanted to switch to R v3) http://cran.r-project.org/bin/linux/debian/wheezy-cran3/. Any tips? Just install from source and

On Thu, Feb 1, 2018 at 5:24 AM, Lionel Henry <lionel at rstudio.com> wrote: > On 31 janv. 2018, at 09:08, Gabriel Becker <gmbecker at ucdavis.edu> wrote: > > > it *actively discourages* the bits it doesn't directly support. > > It may be discouraging to include Rd syntax in roxygen docs but only > because the LaTeX-like syntax of Rd is burdensome, not because