search for: roxygen2

...pted I snippet you?d see in the dplyr package, for instance: #' @importFrom magrittr %>% #' @export magrittr::`%>%` The dplyr package has many statements of this kind and I guess the pattern is common. Roxygn2 will prepare a file documenting the reexport. But the Rd file prepared by Roxygen2 will result in an error saying ?Non-file package-anchored link(s) in documentation object?. The part of the Rd file that is not in line with CRAN requirements is: \code{\link[magrittr]{\%>\%}} Looking around for a solution, I realized that the DT package was adopted recently to address the iss...

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

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

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

...ems like the usage check functions are not prepared for `@` - also in tools:::.S3_method_markup_regexp > On Apr 28, 2023, at 10:34 PM, Karolis Koncevi?ius <karolis.koncevicius at gmail.com> wrote: > > I was building a package that uses the new generic @ and kept having errors with ?roxygen2? documentation. ?roxygen2? generated NAMESPACE added `@.newclass` as a newly exported function, not as a S3method. > > At first I thought this must be a bug in roxygen2 and they lag behind the new developments in R. But after some investigation I found that ?roxygen2? is using tools:::.get_i...

I was building a package that uses the new generic @ and kept having errors with ?roxygen2? documentation. ?roxygen2? generated NAMESPACE added `@.newclass` as a newly exported function, not as a S3method. At first I thought this must be a bug in roxygen2 and they lag behind the new developments in R. But after some investigation I found that ?roxygen2? is using tools:::.get_internal_S3...

Do I understand correctly that we don't want Rd files to be valid latex ? This seems odd to me. I see that `tools::parse_Rd()` doesn't like `\verb!foo!` so maybe roxygen2 is actually doing the right thing (as opposed to just trying to) ? `parse_Rd() ` is probably what I need indeed, for some reason I hadn't found it, so that should fix my own issue here thanks a lot. Le ven. 21 juil. 2023 ? 16:18, Ivan Krylov <krylov.r00t at gmail.com> a ?crit : > ?...

...y point that gives the relevant information (maybe in an identical form to how those internal functions do so, maybe not). If it's not, for some principled reason, something R-core wants to support package and user code doing, then the fact that the new thing doesn't work automatically with roxygen2 would become the roxygen maintainers' job to fix or document. I do not know whether R-core feels this is something packages/users should be able to do; both decisions strike me as possible, to be honest, depending on details I don't know and/or am not privy to. Best, ~G On Fri, Apr 28, 2...

? Fri, 21 Jul 2023 15:14:09 +0200 Antoine Fabri <antoine.fabri at gmail.com> ?????: > On a closer look it seems like roxygen2 introduces those, when using > markdown backtick quoting, if the quoted content is not syntactic. For > instance: > > #' `c(c(1)` > #' `c(c(1))` > > Will convert the first line to `\verb{c(c(1)}` and the second to > `\code{c(c(1))}`. roxygen2 tries to do the right...

Hadley Wickham refactored roxygen, making it more maintainable and robust; the changes are so significant that we decided to nominate it roxygen2: http://cran.r-project.org/web/packages/roxygen2/index.html Some highlights: * it's faster; * usage has been improved (the @usage tag should be obsolete); * @rdname merges documentation for multiple functions into one file. For details, see: https://github.com/klutometis/roxygen/...

Hadley Wickham refactored roxygen, making it more maintainable and robust; the changes are so significant that we decided to nominate it roxygen2: http://cran.r-project.org/web/packages/roxygen2/index.html Some highlights: * it's faster; * usage has been improved (the @usage tag should be obsolete); * @rdname merges documentation for multiple functions into one file. For details, see: https://github.com/klutometis/roxygen/...

...2018 at 3:16 PM, Martin M?ller Skarbiniks Pedersen < traxplayer at gmail.com> wrote: > 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]] > > ___________________...

...ror is due to tools::checkDocFiles eventually calling tools:::.S3_method_markup_regexp and not finding `@` as a valid for S3. This error is gone if we adjust tools:::.S3_method_markup_regexp to pass for ?@? by adding ?\\@? to regexp. Please note that this now is not dependant on using or not using roxygen2 KK. > On Apr 29, 2023, at 12:53 AM, Karolis Koncevi?ius <karolis.koncevicius at gmail.com> wrote: > > 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. &gt...

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

...y point that gives the relevant information (maybe in an identical form to how those internal functions do so, maybe not). If it's not, for some principled reason, something R-core wants to support package and user code doing, then the fact that the new thing doesn't work automatically with roxygen2 would become the roxygen maintainers' job to fix or document. > > I do not know whether R-core feels this is something packages/users should be able to do; both decisions strike me as possible, to be honest, depending on details I don't know and/or am not privy to. > > Best,...

...t, // IN SHORT // What are possible workarounds to "consolidate" documentation for S4 methods that are scattered across different packages (generic and some custom methods in one package, additional custom methods in another package) in a *single* Rd help file while using package 'roxygen2' to generate the actual Rd files? // ADDITIONAL INFORMATION // First of, here are the three facts that "cause" my problem: 1) I'd like the software, i.e. the packages, that I write to be as extendable as possible 2) I pretty much ended up using S4 functionality in everything I...

...to tools::checkDocFiles eventually calling tools:::.S3_method_markup_regexp and not finding `@` as a valid for S3. > This error is gone if we adjust tools:::.S3_method_markup_regexp to pass for ?@? by adding ?\\@? to regexp. > Please note that this now is not dependant on using or not using roxygen2 > KK. >> On Apr 29, 2023, at 12:53 AM, Karolis Koncevi?ius <karolis.koncevicius at gmail.com> wrote: >> >> 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...

...eckDocFiles eventually calling tools:::.S3_method_markup_regexp and not finding `@` as a valid for S3. >> This error is gone if we adjust tools:::.S3_method_markup_regexp to pass for ?@? by adding ?\\@? to regexp. > >> Please note that this now is not dependant on using or not using roxygen2 >> KK. > >>> On Apr 29, 2023, at 12:53 AM, Karolis Koncevi?ius <karolis.koncevicius at gmail.com> wrote: >>> >>> Thank you for such a quick reply, Gabriel, >>> >>> I am not too familiar with the package tools, so cannot speak too confid...

...eventually calling tools:::.S3_method_markup_regexp and not finding `@` as a valid for S3. >>> This error is gone if we adjust tools:::.S3_method_markup_regexp to pass for ?@? by adding ?\\@? to regexp. >> >>> Please note that this now is not dependant on using or not using roxygen2 >>> KK. >> >>>> On Apr 29, 2023, at 12:53 AM, Karolis Koncevi?ius <karolis.koncevicius at gmail.com> wrote: >>>> >>>> Thank you for such a quick reply, Gabriel, >>>> >>>> I am not too familiar with the package tools...

...alling tools:::.S3_method_markup_regexp and not finding `@` as a valid for S3. >>>> This error is gone if we adjust tools:::.S3_method_markup_regexp to pass for ?@? by adding ?\\@? to regexp. >>> >>>> Please note that this now is not dependant on using or not using roxygen2 >>>> KK. >>> >>>>> On Apr 29, 2023, at 12:53 AM, Karolis Koncevi?ius <karolis.koncevicius at gmail.com> wrote: >>>>> >>>>> Thank you for such a quick reply, Gabriel, >>>>> >>>>> I am not too fam...