Re: [R-pkg-devel] Inquiry
On 27/09/2022 9:37 p.m., Rolf Turner wrote: On Tue, 27 Sep 2022 07:43:03 + Georgi Boshnakov wrote: ...functions, that are not meant to be called directly by users, should be documented in a file named -internal.Rd. This is one option, convenient in the use-case of the question. But why export a function that you actively don't want the users to know about? Why would you not want users to know about functions? This strikes me as being overly authoritarian. Of course, to export or not to export is the choice of the package author. It is also sensible to try to protect users from shooting themselves in the foot. However if they really want to shoot themselves in the foot, that's their call. > Anyway, users can always get at non-exported functions using ":::". There are (at least) two kinds of users. The more common kind writes scripts that use your package. I think your argument is valid for that group, though many of them are never going to read your warning about functions being intended for internal use. However, some users are package writers. Once their package is on CRAN, it can be really inconvenient for you to change the behaviour of internal functions that they use, because CRAN will object if your change breaks their tests. That makes it harder to write those internal functions, because you have to get them "right" the first time, or support the bad behaviour if someone relied on it. Duncan Murdoch __ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
[R-pkg-devel] no incoming checks
Dear developers, currently CRAN incoming checks are offline due to network issues at my university. I hope this will be resolved early tomorrow. Best, Uwe Ligges __ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
Re: [R-pkg-devel] Help - Shiny app on CRAN
Dear team, I am having trouble submitting my package to CRAN because the link https://win-builder.r-project.org/ is not accessible. Please advise. Thank you Havisha Jahajeeah On Mon, Sep 26, 2022 at 11:17 PM Ivan Krylov wrote: > It might be easier to help you if you show us your package by > publishing the source code somewhere. > > On Mon, 26 Sep 2022 22:22:48 +0400 > "Jahajeeah, Havisha" wrote: > > > CIvalue2: no visible global function definition for 'qt' > > andgm11: no visible binding for global variable 'ParticleSwarm' > > andgm11: no visible global function definition for 'tail' > > app: no visible global function definition for 'shinyApp' > > dbgm12: no visible binding for global variable 'ParticleSwarm' > > It sounds like your NAMESPACE file isn't properly set up to import the > functions you're using. For the package to work correctly, it should > contain lines > > importFrom(stats, qt) > importFrom(utils, tail) > importFrom(shiny, shinyApp) > > and so on for every function you use that's not in base. > > See Writing R Extensions section 1.5: > > https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Specifying-imports-and-exports > > > Objects in \usage without \alias in documentation object 'Plots': > > 'plots' > > A single Rd file can describe multiple functions, but they should be > both mentioned in the \usage{} section and as an \alias{}. Do you > export two different objects (functions?) named "plots" and "Plots", or > is one of those an error? > > > Bad \usage lines found in documentation object 'BackgroundValues': > > gm11(x0), epgm11(x0), tbgm11(x0), igm11(x0), gm114(x0) > > The \usage{} section must exactly match the definition of the function > (but you can omit default values of the arguments if they're too large > and not very informative), without any other words or punctuation. > > Once your package passes the automated tests, a human volunteer will go > over your package to make sure that it fits the CRAN policy (not > providing a link because you've already read it when you submitted the > package), which includes having good documentation for every function > you export. > > See Writing R Extensions section 2 for more information on this: > > https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Writing-R-documentation-files > > I've also noticed that you're showing us an error message from the CRAN > pre-test infrastructure. You can get these errors (and start fixing > them) faster without spending time waiting for the test result by > running R CMD check --as-cran your_package.tar.gz on your own machine. > > -- > Best regards, > Ivan > [[alternative HTML version deleted]] __ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
Re: [R-pkg-devel] Help - Shiny app on CRAN
Hi, it's not just you; the win-builder server is down for all of us (e.g. https://downforeveryoneorjustme.com/win-builder.r-project.org?proto=https). Uwe Ligges, who maintains this, mentioned (in another thread somewhere) that there were networking issues at his university that are being worked on. FWIW, this is a rare event - the win-builder and CRAN incoming services/servers have a quite solid track record. /Henrik On Wed, Sep 28, 2022 at 2:07 PM Jahajeeah, Havisha wrote: > > Dear team, > > I am having trouble submitting my package to CRAN because the link > https://win-builder.r-project.org/ is not accessible. > > Please advise. > > Thank you > Havisha Jahajeeah > > On Mon, Sep 26, 2022 at 11:17 PM Ivan Krylov wrote: > > > It might be easier to help you if you show us your package by > > publishing the source code somewhere. > > > > On Mon, 26 Sep 2022 22:22:48 +0400 > > "Jahajeeah, Havisha" wrote: > > > > > CIvalue2: no visible global function definition for 'qt' > > > andgm11: no visible binding for global variable 'ParticleSwarm' > > > andgm11: no visible global function definition for 'tail' > > > app: no visible global function definition for 'shinyApp' > > > dbgm12: no visible binding for global variable 'ParticleSwarm' > > > > It sounds like your NAMESPACE file isn't properly set up to import the > > functions you're using. For the package to work correctly, it should > > contain lines > > > > importFrom(stats, qt) > > importFrom(utils, tail) > > importFrom(shiny, shinyApp) > > > > and so on for every function you use that's not in base. > > > > See Writing R Extensions section 1.5: > > > > https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Specifying-imports-and-exports > > > > > Objects in \usage without \alias in documentation object 'Plots': > > > 'plots' > > > > A single Rd file can describe multiple functions, but they should be > > both mentioned in the \usage{} section and as an \alias{}. Do you > > export two different objects (functions?) named "plots" and "Plots", or > > is one of those an error? > > > > > Bad \usage lines found in documentation object 'BackgroundValues': > > > gm11(x0), epgm11(x0), tbgm11(x0), igm11(x0), gm114(x0) > > > > The \usage{} section must exactly match the definition of the function > > (but you can omit default values of the arguments if they're too large > > and not very informative), without any other words or punctuation. > > > > Once your package passes the automated tests, a human volunteer will go > > over your package to make sure that it fits the CRAN policy (not > > providing a link because you've already read it when you submitted the > > package), which includes having good documentation for every function > > you export. > > > > See Writing R Extensions section 2 for more information on this: > > > > https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Writing-R-documentation-files > > > > I've also noticed that you're showing us an error message from the CRAN > > pre-test infrastructure. You can get these errors (and start fixing > > them) faster without spending time waiting for the test result by > > running R CMD check --as-cran your_package.tar.gz on your own machine. > > > > -- > > Best regards, > > Ivan > > > > [[alternative HTML version deleted]] > > __ > R-package-devel@r-project.org mailing list > https://stat.ethz.ch/mailman/listinfo/r-package-devel __ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
Re: [R-pkg-devel] Help - Shiny app on CRAN
Hello, Thank you for the clarification. Havisha On Thu, 29 Sep 2022 at 01:24, Henrik Bengtsson wrote: > Hi, > > it's not just you; the win-builder server is down for all of us (e.g. > https://downforeveryoneorjustme.com/win-builder.r-project.org?proto=https > ). > Uwe Ligges, who maintains this, mentioned (in another thread > somewhere) that there were networking issues at his university that > are being worked on. FWIW, this is a rare event - the win-builder and > CRAN incoming services/servers have a quite solid track record. > > /Henrik > > On Wed, Sep 28, 2022 at 2:07 PM Jahajeeah, Havisha > wrote: > > > > Dear team, > > > > I am having trouble submitting my package to CRAN because the link > > https://win-builder.r-project.org/ is not accessible. > > > > Please advise. > > > > Thank you > > Havisha Jahajeeah > > > > On Mon, Sep 26, 2022 at 11:17 PM Ivan Krylov > wrote: > > > > > It might be easier to help you if you show us your package by > > > publishing the source code somewhere. > > > > > > On Mon, 26 Sep 2022 22:22:48 +0400 > > > "Jahajeeah, Havisha" wrote: > > > > > > > CIvalue2: no visible global function definition for 'qt' > > > > andgm11: no visible binding for global variable 'ParticleSwarm' > > > > andgm11: no visible global function definition for 'tail' > > > > app: no visible global function definition for 'shinyApp' > > > > dbgm12: no visible binding for global variable 'ParticleSwarm' > > > > > > It sounds like your NAMESPACE file isn't properly set up to import the > > > functions you're using. For the package to work correctly, it should > > > contain lines > > > > > > importFrom(stats, qt) > > > importFrom(utils, tail) > > > importFrom(shiny, shinyApp) > > > > > > and so on for every function you use that's not in base. > > > > > > See Writing R Extensions section 1.5: > > > > > > > https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Specifying-imports-and-exports > > > > > > > Objects in \usage without \alias in documentation object 'Plots': > > > > 'plots' > > > > > > A single Rd file can describe multiple functions, but they should be > > > both mentioned in the \usage{} section and as an \alias{}. Do you > > > export two different objects (functions?) named "plots" and "Plots", or > > > is one of those an error? > > > > > > > Bad \usage lines found in documentation object 'BackgroundValues': > > > > gm11(x0), epgm11(x0), tbgm11(x0), igm11(x0), gm114(x0) > > > > > > The \usage{} section must exactly match the definition of the function > > > (but you can omit default values of the arguments if they're too large > > > and not very informative), without any other words or punctuation. > > > > > > Once your package passes the automated tests, a human volunteer will go > > > over your package to make sure that it fits the CRAN policy (not > > > providing a link because you've already read it when you submitted the > > > package), which includes having good documentation for every function > > > you export. > > > > > > See Writing R Extensions section 2 for more information on this: > > > > > > > https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Writing-R-documentation-files > > > > > > I've also noticed that you're showing us an error message from the CRAN > > > pre-test infrastructure. You can get these errors (and start fixing > > > them) faster without spending time waiting for the test result by > > > running R CMD check --as-cran your_package.tar.gz on your own machine. > > > > > > -- > > > Best regards, > > > Ivan > > > > > > > [[alternative HTML version deleted]] > > > > __ > > R-package-devel@r-project.org mailing list > > https://stat.ethz.ch/mailman/listinfo/r-package-devel > [[alternative HTML version deleted]] __ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
Re: [R-pkg-devel] Inquiry
On Wed, 28 Sep 2022 05:19:06 -0400 Duncan Murdoch wrote: > However, some users are package writers. Once their package is on > CRAN, it can be really inconvenient for you to change the behaviour > of internal functions that they use, because CRAN will object if your > change breaks their tests. That makes it harder to write those > internal functions, because you have to get them "right" the first > time, or support the bad behaviour if someone relied on it. Surely package writers should not write code that uses internal functions, irrespective of whether these functions are exported. I don't think that I ever have. (That last could be wishful thinking I guess.) Not exporting makes it harder for package writers to know about the *existence* of such functions, but it's not impossible (or even really difficult) for a package-writer-type to find out about them. The write can always then make a copy of the code in their own package, which eliminates the problem with dependencies. Anyway, does everybody 'get them "right" the first time'? :-) cheers, Rolf -- Honorary Research Fellow Department of Statistics University of Auckland Phone: +64-9-373-7599 ext. 88276 __ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
Re: [R-pkg-devel] no incoming checks
On 28.09.2022 17:33, Uwe Ligges wrote: Dear developers, currently CRAN incoming checks are offline due to network issues at my university. I hope this will be resolved early tomorrow. Best, Uwe Ligges This has been resolved last night (by a reboot of the central switch of the university) and is currently catching up with submissions. Best, Uwe Ligges __ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel