similar to: roxygen2

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

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 all, I'm trying to come to grips with how to document S4 methods using ROxygen - mostly following posts such as this: http://tinyurl.com/ae3kdno I just can't get it to work (this is roxygen2_2.2.2). I attach an example below which seems parsed properly, but "R CMD check" keeps complaining > ... > Undocumented S4 methods: > ... > generic 'set<-' and

Dear Duncan, With all respect, but I strongly disagree on your stance regarding roxygen2 for multiple reasons: 1. It is in my humble opinion not correct to evaluate a tool based on the abuse of some users. It's not because people write packages with bad documentation, that roxygen2 is to blame. I use roxygen2, and I care a great deal about documentation. So I actually took a bit offense

# Roxygen2 The premise of `roxygen2` is simple: describe your functions in comments next to where their definitions and `roxygen2` will process your source code and comments to produce R compatible Rd files. Here's a simple example from the `stringr` package: ? ? #' The length of a string (in characters).? ? #'? ? #' @param string input character vector? ? #' @return numeric

# Roxygen2 The premise of `roxygen2` is simple: describe your functions in comments next to where their definitions and `roxygen2` will process your source code and comments to produce R compatible Rd files. Here's a simple example from the `stringr` package: ? ? #' The length of a string (in characters).? ? #'? ? #' @param string input character vector? ? #' @return numeric

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

Dear colleagues, preparing a release of my package ?polmineR? I encountered the following issue with a new warning issued when running R CMD check with the --as-cran option on Debian with R-devel. To reexport the magrittr pipe operator %>%, my package adopted I snippet you?d see in the dplyr package, for instance: #' @importFrom magrittr %>% #' @export magrittr::`%>%` The

On Tue, Jan 30, 2018 at 4:55 PM, Duncan Murdoch <murdoch.duncan at gmail.com> wrote: > 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

On 30/01/2018 11:39 PM, Hadley Wickham wrote: > On Tue, Jan 30, 2018 at 4:55 PM, Duncan Murdoch > <murdoch.duncan at gmail.com> wrote: >> 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 >>>

It is indeed a matter of what the developer is comfortable with and the one-stop solution provided by devtools is difficult to beat. This may also vary across projects. I use EMACS/ESS with and without roxygen2. In some cases EMACS/ESS+Org mode provides stunning benefits. Updating "usage" statements in Rd files was mentioned several times. Rdpack::reprompt() does this and more for

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

Hi, I am trying to create my first R package. I will later today put the files on Github. However I gets this error and I can't find any reason for it: R> roxygen2::roxygenise() First time using roxygen2. Upgrading automatically... Error in x$tag : $ operator is invalid for atomic vectors R> Any ideas? Regards Martin M. S. Pedersen [[alternative HTML version deleted]]

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

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 R-SIG-Debian Team, r-devel sent me to you. Situation: Ubuntu 16.04, R-3.3.1, and a file in a folder mounted with sftp via gnome virtual file system. for(i in 1:10){cat(i,file = "/run/user/1001/gvfs/sftp:host=server/path on server/test2",append = TRUE)} gives a file that reads |10| and not |12345678910| Further checking: * A mapped network drive on Windows 7 and

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

Thank you for such a quick reply, Gabriel, I am not too familiar with the package tools, so cannot speak too confidently, but below is how I see the issue currently. The issue is not for external packages to rely on unexported functions from tools::, rather the issue is that 'R CMD check ?as-cran' runs those functions from tools:: in order to check the validity of Rd files (from any