similar to: roxygen

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

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

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 fully agree with Joris and Hadley on roxygen2. Additionally: I wrote and published my first package before roxygen (or roxygen2) was available. I found editing .Rd extremely terse (especially when code is updated). For example, the fact that there are no spaces allowed between } and { in \param{}{} has hurt my brain quite a few times, especially since R CMD check did not give any useful error

On 30/01/2018 4:30 PM, Kenny Bell wrote: > In response to Duncan regarding the use of roxygen2 from the point of view > of a current user, I believe the issue he brings up is one of correlation > rather than causation. Could be. However, I think editing comments in a .R file is a bit harder than editing text in a .Rd file, so I think the format discourages editing. I think it does

Dear All: stepping in late, but @Joris, if you would like to take 'from a single file' literally, have a look at: https://github.com/bpfaff/lp4rp (lp4rp: literate programming for R packages); Cheers, Bernhard ps: incidentally, within the noweb-file roxygen is employed. -----Urspr?ngliche Nachricht----- Von: R-devel [mailto:r-devel-bounces at r-project.org] Im Auftrag von Joris

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

Joris, With the large caveat that I am not Duncan, and thus am not speaking for him, I can see an argument for his claim that I think is, more or less, true. roxygen2 (as far as I know as someone who uses it at least some of the time) maps to only a subset of Rd. It is the most commonly used subset, and so you can do most common things with it, but I think a pretty good case can be made for the

On 31/01/2018 6:33 AM, Joris Meys wrote: > 3. given your criticism, I'd like your opinion on where I can improve > the documentation of https://github.com/CenterForStatistics-UGent/pim. > I'm currently busy updating the help files for a next release on CRAN, > so your input is more than welcome. After this invitation I sent some private comments to Joris. I would say his

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

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.

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

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

Karolis, It seems likely, without having looked myself, that you could be correct about the issue, but it does seem worth noting that both of the functions you have mentioned are not exported, and thus not part of the API that extension packages are allowed to use and rely on. If retrieving the list of "internal S3 generics" is something package and user code is allowed to do, the real

Hi Quite a few R packages are now available on GitHub long before they appear on CRAN, installation is simple thanks to devtools::install_github(). However, it seems to be common practice to keep the .Rd files (and NAMESPACE and the Collate section in the DESCRIPTION) in the Git tree, and to manually update it, even if they are autogenerated from the R code by roxygen2. This requires extra