Re: [R-pkg-devel] How to avoid R CMD check warning for documentation of non-package functions?

[Konrad Rudolph]

On Wed, Dec 2, 2020 at 7:44 PM Duncan Murdoch  wrote:
> I haven't tried this, but I believe if you define functions with the
> right name and header in your package but don't export them the warning
> will go away.

Thanks, works like a charm.

> If that doesn't work (or defining those causes other issues), a more
> involved workaround would be to change the \docType{} declaration for
> the help page.  \docType{package} is the most free-form, but you might
> get warned if you have two of them.  \docType{data} might be flexible
> enough.  If you do this, you won't use \usage{} or \arguments{}, you'll
> put together your own sections using \section{Usage}{ ... } and
> \section{Arguments}{ ... } and try to get the formatting right.

I’ll keep this in mind! It might come handy.

-- 
Konrad Rudolph // @klmr

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

Re: [R-pkg-devel] Failing vignette engine for package rasciidoc on solaris

[Andreas Dominik Cullmann via R-package-devel]

Dear Duncan,
thank you very much, saved my day!
Best,
Dominik
On Mon, Nov 23, 2020 08:17:17, Duncan Murdoch wrote:
> On 23/11/2020 7:07 a.m., Andreas Dominik Cullmann via R-package-devel wrote:
> > Dear List,
> > one of my packages, rasciidoc (a simple wrapper to 'knitr' and 'asciidoc'),
> > includes a minimal vigentte engine.
> > When submitting the package with a vignette using that engine, the vignette 
> > is
> > re-built on all platforms except for r-patched-solaris-x86:
> > https://cran.r-project.org/web/checks/check_results_rasciidoc.html
> > https://www.r-project.org/nosvn/R.check/r-patched-solaris-x86/rasciidoc-00check.html
> > 
> > Maybe rasciidoc's vignette engine is somewhat superfluous, but since it 
> > works
> > for all platforms except solaris, I kind of would like to use it.
> > 
> > I cannot reproduce the error using rhub:
> >## Test environments
> >- R-hub solaris-x86-patched-ods (r-release)
> >## R CMD check results
> >❯ On solaris-x86-patched-ods (r-release)
> >  checking CRAN incoming feasibility ... WARNING
> >  Maintainer: ‘Andreas Dominik Cullmann ’
> >  Insufficient package version (submitted: 2.2.1, existing: 2.2.1)
> >  Days since last update: 5
> >❯ On solaris-x86-patched-ods (r-release)
> >  checking top-level files ... NOTE
> >  Files ‘README.md’ or ‘NEWS.md’ cannot be checked without ‘pandoc’ 
> > being installed.
> >❯ On solaris-x86-patched-ods (r-release)
> >  checking examples ... NOTE
> >  Examples with CPU (user + system) or elapsed time > 5s
> > user system elapsed
> >  rasciidoc 2.724  0.352   48.75
> >0 errors ✔ | 1 warning ✖ | 2 notes ✖
> > 
> > 
> > And I happen to have no solaris box at hand for testing.
> > Does anybody have any suggestion on how I could tackle this?
> 
> The error message says:   "Can't find program `source-highlight`. Please
> install first (http://www.gnu.org/software/src-highlite/)."  You have listed
> this in SystemRequirements as "recommended", but even if you had listed it
> as required, your build shouldn't fail if it is not found:  it should test
> for that program, and continue on if it is not there.  For example, it could
> output a vignette containing nothing except the warning message that
> source-highlight is needed to build the vignette. This is described in
> Section 1.6, "Writing portable packages", of Writing R Extensions.
> 
> Duncan Murdoch

-- 
https://www.globalplanetauthority.com/

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel