similar to: Roxygen to ignore a block of code?

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

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

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

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

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

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

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

Is this the appropriate place for GSoC conversations? If I understand the proposal correctly, there should be a lexer (written in R) that exposes an API; that API would be used by segregated mini-parsers (Roclets) which do the dirty work of Roxygen -> {html, LaTeX, DocBook, ...} translation. The lexer should ship with a proof-of-concept Roclet. Have I missed anything?

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

Folks: I am getting a build failure when I: #' @importFrom utils shortPathName which roxygenizes it to the NAMESPACE. I suspect this is because this particular function is Windows-only, but I'm a bit confused how I should "properly" importFrom a function like this so it doesn't cause a build failure, but I don't get a note in my R CMD CHECK if I DON'T have it:

I am developing an R package which has a function I decided not to export. I believe the roxygen information states that the function is not going to be exported, yet I still see the function in the manual PDF (as generated in command line via `CMD Rd2pdf package_dir`). What is wrong with my preamble that the function is still being documented in a manual? #' Generates plots for demo of

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.

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

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

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.