search for: roxygen

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

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 other? Thanks in advance. - Ken -- View this message in context: http://www.nabble.com/Roxygen-vs-Sweave-for-S4-documentation-tp24131590p24131590.html Sent fro...

...> > 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 NAMESPACE file. Apparently > roxygen2 doesn't support this feature, so you'll have to do it by hand. > > 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 t...

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

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("...

...ment. So if you load all the functions that you want > in your new package into your R environment, then call > package.skeleton, you'll have a starting point. > > At that point, I would probably recommend moving to RStudio, and using > RStudio to generate markdown comments for roxygen for all your newly > created function files. Then you could finish off the documentation by > writing it in these roxygen skeletons or copying and pasting from > comments in your original code files. I'd agree about moving to RStudio, but I think Roxygen is the wrong approach for do...

...ges 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 Roxygen to generate man files 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 &quo...

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

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}. #' @callGraphPrimiti...

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

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

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

...t; [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 NAMESPACE file. Apparently >> roxygen2 doesn't support this feature, so you'll have to do it by hand. >> >> Duncan Murdoch >> >> > > This has been submitted as an issue at > > https://github.com/klutometis/roxygen/issues/378 > > closely related: > > https://github.com/klutomet...

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

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

...functions that you want > > in your new package into your R environment, then call > > package.skeleton, you'll have a starting point. > > > > At that point, I would probably recommend moving to RStudio, and using > > RStudio to generate markdown comments for roxygen for all your newly > > created function files. Then you could finish off the documentation by > > writing it in these roxygen skeletons or copying and pasting from > > comments in your original code files. > > I'd agree about moving to RStudio, but I think Roxygen...

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 file names: ?getMarketTradedVolume.Rd? ?sfdsfsd? * checking for LF line-endings in source and mak...

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

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

...b 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 of > roxygen. It is still handy to have inlined Rd as a backup and we do > use it for the cases where we need finer grained control. > I only somewhat agree with this. Part of it is the Rd specifically, I ag...