[R-pkg-devel] How to fix "attribute "id" has invalid value" when submitting new package to CRAN

[Han Zhang]

Hi Ivan,

Thank you for your suggestions. These notes are eliminated after space is
removed from R6 class name!

Best,
Han

On Tue, Feb 18, 2025 at 5:20 AM Ivan Krylov <ikrylov using disroot.org> wrote:

> Dear Han Zhang,
>
> Welcome to R-package-devel!
>
> В Mon, 17 Feb 2025 23:28:24 -0500
> Han Zhang <zhangh.ustc using gmail.com> пишет:
>
> > Found the following
> > HTML validation problems: GraphicalTesting.html:114:1
> > (GraphicalTesting.Rd:170): Warning: <a> attribute "id" has invalid
> > value "method-Graphical Testing Procedure-new"
>
> Thank you for providing the NOTE you are receiving. It's best to also
> provide a link to the source code of your package, because the error
> messages alone are frequently not enough to diagnose the problem, and
> it's not always easy to find out the code in question from a few
> breadcrumbs in the error messages.
>
> In the few cases I've checked, R CMD check points at the lines
> containing \if{html}{\out{...}} statements [1]. This seems to be a
> problem with 'roxygen2': it did not expect your class name to contain
> spaces [2], so it did not replace them in the 'id' attribute while
> generating the HTML fragment for the class documentation. You can
> rename the class or ask the 'roxygen2' developers to adjust their HTML
> generation.
>
> In the future, please compose your messages to this list in plain text.
> When you compose them in HTML, we only receive the plain text version
> automatically generated by your mailer, which doesn't present the
> intended formatting intact [3].
>
> Good luck!
>
> --
> Best regards,
> Ivan
>
> [1]
>
> https://github.com/zhangh12/TrialSimulator/blob/93b6ef034108f4562a7658c33b9c946346ea9d1c/man/GraphicalTesting.Rd#L170
>
> [2]
>
> https://github.com/zhangh12/TrialSimulator/blob/93b6ef034108f4562a7658c33b9c946346ea9d1c/R/GraphicalTesting.R#L139
>
> [3]
> https://hypatia.math.ethz.ch/pipermail/r-package-devel/2025q1/011504.html
>

	[[alternative HTML version deleted]]