Skip to content

Roxygen Documentation

2 messages · Glenn Schultz, Jeff Newmiller

Original
Glenn Schultz
# 
Hello R help,
I am in the process of creating the companion to my book which illustrates how to call Bond Lab (my R package for MBS and fixed income). ?

I started with the idea of scripts and then functions calling functions. ?Neither seemed very good to me. ?I checked a couple of packages (Max Kuhn, etc.). ?The companions were mostly scripts that the user can copy paste. ?So, I thought I would try that with Roxygen2. ? I have tried a few iterations. ?The code I have tried is variation of below and?does?not?work.? Does anyone know if I can use Roxygen2 in this way or do I need to seek an alternative.

Thanks,
Glenn

#' Chapter 1 Present Value Function Example
#'?
#' The script example calls the presesnt value function
#' from the package BondLab
#' @examples
#' \dontrun{
require(BondLab)
PV = TimeValue(interest.rate = .05,
? ? ? ? ? ? ? ?number.periods = 3,
? ? ? ? ? ? ? ?frequency = 1,
? ? ? ? ? ? ? ?type = "PV")}
Jeff Newmiller
# 
I think you are looking for a way to make a vignette. Consider using the Sweave variant of knitr.
---------------------------------------------------------------------------
Jeff Newmiller                        The     .....       .....  Go Live...
DCN:<jdnewmil at dcn.davis.ca.us>        Basics: ##.#.       ##.#.  Live Go...
                                      Live:   OO#.. Dead: OO#..  Playing
Research Engineer (Solar/Batteries            O.O#.       #.O#.  with
/Software/Embedded Controllers)               .OO#.       .OO#.  rocks...1k
--------------------------------------------------------------------------- 
Sent from my phone. Please excuse my brevity.
On May 22, 2015 6:03:21 PM PDT, Glenn Schultz <glennmschultz at me.com> wrote: