[R-pkg-devel] Strange warnings from build

[Hadley Wickham]

Take a look at this line:

#' #' Pass through OAS engine

Hadley

On Sat, Nov 28, 2015 at 11:33 AM, Glenn Schultz <glennmschultz at me.com> wrote:
> Hello All,
>
> When I build my package.  I get the following warnings.  I think these are
> related to LaTex and ElCapitan but are flowing through to my R build. All
> the tests pass and the help files work.  These are just warnings but are
> frustrating nonetheless.
>
> Note: I just up graded to El Capitan OS - This blew out my Tex Maker / Knitr
> to the point that I was ready to give up.  I had to uninstall mactex and
> texmaker twice but everything seems to be  working okay as far a knitr and
> Tex Maker is concerned - basically I can knit my document and get the same
> results as before.
>
> I am not sure where to start to correct the R build warnings and I have been
> researching for about 2-3 weeks.  I am a little more fearful of the R build
> warnings than the Tex Maker / Knitr as that issue was basically one of path.
> In R build case I just don't know, so I am a little more fearful.  If
> someone could give me a nudge in the right direction I would appreciate the
> help.
>
> Glenn
>
> The new warnings are:
> ===============================================================
> This is the first one
> ================================================================
> Undocumented arguments in documentation object 'Mortgage.OAS'
> ‘bond.id’ ‘trade.date’ ‘settlement.date’ ‘original.bal’ ‘price’
> ‘sigma’ ‘paths’
>
>
> The code for the constructor function is documented.
>
> #' Mortgage OAS the OAS engine for pass through OAS
> #' #' Pass through OAS engine
> #' @param bond.id A character string the bond id or cusip number
> #' @param trade.date A character string the trade date
> #' @param settlement.date A character string the settlement date
> #' @param original.bal A numeric value the pool original balance
> #' @param price A numeric value the price of the pass through
> #' @param sigma A numeric value the volatility assumption (not annualized)
> #' @param paths A numeric value the number of paths
> #' @importFrom lubridate %m+%
> #' @export Mortgage.OAS
> Mortgage.OAS <- function(bond.id = "character", trade.date = "character",
> settlement.date = "character", original.bal = numeric(),
> price = numeric(), sigma = numeric(), paths = numeric()
> ){ some stuff to do OAS}
>
> ============================================================
> The other is
> ============================================================
>
> Functions with \usage entries need to have the appropriate \alias
> entries, and all their arguments documented.
> The \usage entries must correspond to syntactically valid R code.
> See chapter ‘Writing R documentation files’ in the ‘Writing R
> Extensions’ manual.
> * checking Rd contents ... OK
> * checking for unstated dependencies in examples ... OK
> * checking examples ... OK
> Examples with CPU or elapsed time > 5s
> user system elapsed
> REMIC.OAS 22.746 0.351 23.100
> PassThroughOAS 11.449 0.067 11.518
> * checking PDF version of manual ... WARNING
> LaTeX errors when creating PDF version.
> This typically indicates Rd problems.
> LaTeX errors found:
> ! You can't use `macro parameter character #' in horizontal mode.
> l.1175 #
> # Not run: need example
> Sorry, but I'm not programmed to handle this case;
> I'll just pretend that you didn't ask for it.
> ! You can't use `macro parameter character #' in horizontal mode.
> l.1175 ##
>
> ______________________________________________
> R-package-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel



-- 
http://had.co.nz/