Re: [R-pkg-devel] Redirect error in .Rd file

2021-05-26 Thread Deepayan Sarkar
On Wed, May 26, 2021 at 2:23 AM Lenth, Russell V
 wrote:
>
> Hello package developers,
>
> I just upgraded to R version 4.1.0, and now get a new error when I re-build 
> my package. Among the messages about converting help files, I now get:
>
> ...
> update.emmGrid  html
> REDIRECT:topic   levels<-.emmGrid -> update.emmGrid.html [ FAIL ]
> ...
>
> But I don't see anything wrong. In my source code, I have ROxygen tags like 
> this:

You can ignore this; the message just tells you that an attempt to
create a file named "levels<-.emmGrid.html" has failed (because < is
not allowed in file names in Windows).

This will not impact anything _unless_ another package has a
documentation link of the form \link[pkg:levels<-.emmGrid], in which
case the link will fail (but only for static HTML help, which is
rarely used any more).

Best,
-Deepayan

> #' @rdname update.emmGrid
> #' @export
> #' @param x an \code{emmGrid} object
> ...
> #'
> "levels<-.emmGrid" = function(x, value) {
> update.emmGrid(x, levels = value)
> }
>
> And the file update.emmGrid.Rd starts like this:
>
> % Generated by roxygen2: do not edit by hand
> % Please edit documentation in R/emmGrid-methods.R
> \name{update.emmGrid}
> \alias{update.emmGrid}
> \alias{levels<-.emmGrid}
> \title{Update an \code{emmGrid} object}
> \usage{
> \method{update}{emmGrid}(object, ..., silent = FALSE)
>
> \method{levels}{emmGrid}(x) <- value
> }
> ...
>
> This all looks right to me. The help page documents both functions and shows 
> parameters, details, and examples for both functions. If I ask for help for 
> either function, it brings up this page. The only thing I see wrong is the 
> message from building it. Any suggestions?
>
>
> Russell V. Lenth  -  Professor Emeritus
> Department of Statistics and Actuarial Science
> The University of Iowa  -  Iowa City, IA 52242  USA
> Voice (319)335-0712 (Dept. office)  -  FAX (319)335-3017
>
>
> __
> 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


[R-pkg-devel] Redirect error in .Rd file

2021-05-25 Thread Lenth, Russell V
Hello package developers,

I just upgraded to R version 4.1.0, and now get a new error when I re-build my 
package. Among the messages about converting help files, I now get:

...
update.emmGrid  html  
REDIRECT:topic   levels<-.emmGrid -> update.emmGrid.html [ FAIL ]
...

But I don't see anything wrong. In my source code, I have ROxygen tags like 
this:

#' @rdname update.emmGrid
#' @export
#' @param x an \code{emmGrid} object
...
#' 
"levels<-.emmGrid" = function(x, value) {
update.emmGrid(x, levels = value)
}

And the file update.emmGrid.Rd starts like this:

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/emmGrid-methods.R
\name{update.emmGrid}
\alias{update.emmGrid}
\alias{levels<-.emmGrid}
\title{Update an \code{emmGrid} object}
\usage{
\method{update}{emmGrid}(object, ..., silent = FALSE)

\method{levels}{emmGrid}(x) <- value
}
...

This all looks right to me. The help page documents both functions and shows 
parameters, details, and examples for both functions. If I ask for help for 
either function, it brings up this page. The only thing I see wrong is the 
message from building it. Any suggestions?


Russell V. Lenth  -  Professor Emeritus
Department of Statistics and Actuarial Science   
The University of Iowa  -  Iowa City, IA 52242  USA   
Voice (319)335-0712 (Dept. office)  -  FAX (319)335-3017


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