Re: [R-pkg-devel] roxygen style documentation for data sets

2023-09-21 Thread Duncan Murdoch
click Run, as one can do with roxygen documentation in .R files. -Michael -Original Message- From: Duncan Murdoch Sent: Thursday, September 21, 2023 3:58 PM To: Michael L Friendly ; r-package-devel@r-project.org Subject: Re: [R-pkg-devel] roxygen style documentation for data sets Hi Micha

Re: [R-pkg-devel] roxygen style documentation for data sets

2023-09-21 Thread Jeff Newmiller via R-package-devel
>-Michael > >-Original Message- >From: Duncan Murdoch >Sent: Thursday, September 21, 2023 3:58 PM >To: Michael L Friendly ; r-package-devel@r-project.org >Subject: Re: [R-pkg-devel] roxygen style documentation for data sets > >Hi Michael. > >I don'

Re: [R-pkg-devel] roxygen style documentation for data sets

2023-09-21 Thread Michael L Friendly
Message- From: Duncan Murdoch Sent: Thursday, September 21, 2023 3:58 PM To: Michael L Friendly ; r-package-devel@r-project.org Subject: Re: [R-pkg-devel] roxygen style documentation for data sets Hi Michael. I don't know if you're an RStudio user, but this seems ideal as the b

Re: [R-pkg-devel] roxygen style documentation for data sets

2023-09-21 Thread John Fox
Hi Michael, I'm no license expert either, but I too believe that while a GPL-licensed package can incorporate MIT-licensed code, an MIT-licensed package can't incorporate GPL-licensed code. One solution, I think, would be to put your use_data_doc() in a separate GPL-licensed package, which t

Re: [R-pkg-devel] roxygen style documentation for data sets

2023-09-21 Thread Duncan Murdoch
Hi Michael. I don't know if you're an RStudio user, but this seems ideal as the basis for an RStudio plug-in. Just install it, then when you want to generate docs for some dataset defined in R code, move to the start of the definition and hit some hot key to insert the documentation skeleton

Re: [R-pkg-devel] roxygen style documentation for data sets

2023-09-21 Thread Michael L Friendly
ginal Message- From: Ivan Krylov Sent: Thursday, September 21, 2023 1:37 PM To: Michael L Friendly Cc: r-package-devel@r-project.org Subject: Re: [R-pkg-devel] roxygen style documentation for data sets В Thu, 21 Sep 2023 16:33:35 + Michael L Friendly пишет: > I called this function `use_

Re: [R-pkg-devel] roxygen style documentation for data sets

2023-09-21 Thread Ivan Krylov
В Thu, 21 Sep 2023 16:33:35 + Michael L Friendly пишет: > I called this function `use_data_doc()`, because I thought it would > be a welcome addition to the usethis package. > > I hope that someone on this list can advise how to make such a > function available to all R package developers.

[R-pkg-devel] roxygen style documentation for data sets

2023-09-21 Thread Michael L Friendly
I have many datasets in a some of my packages, and always used `utils::promptData()` to generate the skeleton of a man/data.Rd file. Now that I've switched to roxygen style, I have found no simple equivalent. In fact, with RStudio tools for generating documentation for functions, it is surprising