man/setCacheDir.Rd

   1 \name{setCacheDir}
   2 \alias{setCacheDir}
   3 \alias{getCacheDir}
   4
   5 \title{Set Cache Directory}
   6 \description{
   7   Set/Get cache directory where files are stored
   8 }
   9 \usage{
  10 setCacheDir(path)
  11 getCacheDir()
  12 }
  13
  14 \arguments{
  15   \item{path}{character, directory where cache files will be stored}
  16 }
  17 \details{
  18   \code{setCacheDir} will create the cache directory if it does not
  19   already exist.  When the package \code{cacheSweave} is loaded, the
  20   cache directory is initially set to the current directory (".").
  21   This function should generally be called in the very first code chunk
  22   of the Sweave document and caching should \emph{not} be turned on for
  23   that code chunk.
  24 }
  25 \value{
  26   \code{getCacheDir} returns the current cache directory.
  27 }
  28 \author{Roger D. Peng \email{rpeng@jhsph.edu}}
  29
  30 \keyword{utilities}% at least one, from doc/KEYWORDS