similar to: Compose in roxygen - order of function application?

> -----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, 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

On 04/10/2015 7:34 PM, Ben Bolker wrote: > Duncan Murdoch <murdoch.duncan <at> gmail.com> writes: > >> >> On 04/10/2015 10:10 AM, Jonathan Greenberg wrote: >>> Folks: >>> > > [snip snip snip] > >>> >>> Is there a way to do a conditional importFrom based on the OS? Or can I >>> safely ignore this (I'm trying

Dear List, I ran into the following two problems while using the package 'roxygen': QUESTION 1 I split the relevant R-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.

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

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 #'

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

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

Hello useRs, I'm trying to 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",

I am trying to make a package consisting of a single function with auto-documentation assistance from 'roxygen' but am uncertain of the correct procedure. My version of 'R' is 2.10.1. I followed the following steps: 1) Get an existing function (un-commented) as an '.R' file. 2) Add formal comments (e.g. owner) above that function's code using the [#' @] syntax.

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.

Dear all, I'm using Roxygen for the first time and I'm getting a rather cryptic error message. I must be doing something wrong but I have no clue what is it. Any suggestions? Regards, Thierry roxygenize("AFLP", roxygen.dir = "AFLP", copy.package = FALSE, unlink.target = FALSE) Writing AFLP.outlier to AFLP/man/AFLP.outlier.Rd Writing AFLP.outlier to

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

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

Duncan Murdoch <murdoch.duncan <at> gmail.com> writes: > > On 04/10/2015 10:10 AM, Jonathan Greenberg wrote: > > Folks: > > [snip snip snip] > > > > Is there a way to do a conditional importFrom based on the OS? Or can I > > safely ignore this (I'm trying to submit to CRAN). > > > > Yes, you can put conditionals into the

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

I'm trying to use Roxygen for the first time, but I'm running into trouble. I call it like so: roxygenize('~/p4/r-packages/IREval', '~/p4/r-packages/IREval', unlink.target=T) But it seems that it's only appending to files in ~/p4/r-packages/IREval/man/, not overwriting them. So for example, for a function that I haven't documented yet I get a long

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

We're pleased to announce that Henning Redestig finally implemented ESS support for Roxygen: http://www.metabolome.jp/download/ess-roxy/ess-roxy.el/view ess-roxy includes paragraph fill, hiding, template generation, etc.

Hi, I'm writing documentation using Roxygen and writing in Swedish. But I can't use ??? for instance and I haven't found any encoding option in the R-manual. Is there any one that can help me? Regards Serdar