[R-pkg-devel] documentation warning when using \deqn for equations

Duncan Murdoch murdoch@dunc@n @end|ng |rom gm@||@com
Fri Mar 25 19:44:25 CET 2022


On 25/03/2022 2:19 p.m., Gillian Sharer wrote:
> My package submission has just started generating a NOTE for HTML check warnings in my .Rd documentation files when using \deqn to document equations, although it has been successful in the past. It passes all checks on the rhub package machines, but the Debian build for actual submissions is reporting for each use of \deqn:

There's been some work on Rd parsing recently in R-devel that could have 
created some false-positive issues.  It's probably easiest just to wait 
a day or two to see if the warnings go away.

Duncan Murdoch

> 
> 
> Warning: inserting implicit <p>
> Warning: trimming empty <p>
> 
> 
> The reported line numbers don't match, but this is only occurring in files with \deqn and the number of warnings matches the number of \deqn uses.
> 
> An example is:
> \details {
> Before calculating the envelope, the seismic trace is 'cleaned up' by removing the mean,
> the trend and by applying a cosine taper. See \link{DDT} for more details.
> 
> The seismic envelope is defined as:
> 
> 
> 
> 
> \deqn{ E(t) = \sqrt{T^2(t) + H^2(t)} }
> 
> 
> 
> 
> where \eqn{T(t)} is the seismic trace and \eqn{H(t)} is the Hilbert transform of \eqn{T(t)}.
> 
> }
> 
> 
> 
> 
> Is there anything obviously wrong with this?
> 
> 
> 
> 
> Thanks,
> 
> Gillian Sharer
> 
> IRIS DMC
> 
> gillian using iris.washington.edu
> 
> 
> 
> 	[[alternative HTML version deleted]]
> 
> ______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel



More information about the R-package-devel mailing list