%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  999.package.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{R.cache-package}
\alias{R.cache-package}
\alias{R.cache}
\docType{package}

\title{Package R.cache}


\description{
  Memoization can be used to speed up repetitive and computational expensive function calls.  The first time a function that implements memoization is called the results are stored in a cache memory.  The next time the function is called with the same set of parameters, the results are momentarily retrieved from the cache avoiding repeating the calculations.  With this package, any R object can be cached in a key-value storage where the key can be an arbitrary set of R objects.  The cache memory is persistent (on the file system).
}

\section{Installation and updates}{
  To install this package and all of its dependent packages, do:
  \code{install.packages("R.cache")}
}

\section{To get started}{
  \describe{
   \item{\link{loadCache}, \link{saveCache}}{
     Methods for loading and saving objects from and to the cache.
   }
   \item{\link{getCacheRootPath}, \link{setCacheRootPath}}{
     Methods for getting and setting the directory where cache
     files are stored.
   }
  }
}

\section{How to cite this package}{
  Whenever using this package, please cite [1] as

  \preformatted{
Bengtsson, H. The R.oo package - Object-Oriented Programming with References Using
Standard R Code, Proceedings of the 3rd International Workshop on Distributed
Statistical Computing (DSC 2003), ISSN 1609-395X, Hornik, K.; Leisch, F. & Zeileis,
A. (ed.), 2003
}

}

\section{Wishlist}{
 Here is a list of features that would be useful, but which I have
 too little time to add myself. Contributions are appreciated.
 \itemize{
   \item Add a functionality to identify cache files that are
      no longer of use.  For now, there is an extra header field
      for arbitrary comments which can be used, but maybe more
      formal fields are useful, e.g. keywords, user, etc?
 }

 If you consider implement some of the above, make sure it is not
 already implemented by downloading the latest "devel" version!
}

\section{Related work}{
 See also the \pkg{filehash} package, and the \code{cache()} function
 in the \pkg{Biobase} package of Bioconductor.
}

\author{Henrik Bengtsson}

\section{License}{
  The releases of this package is licensed under LGPL version 2.1 or newer.
}

\section{References}{
[1] H. Bengtsson, \emph{The R.oo package - Object-Oriented Programming with References Using Standard R Code}, In Kurt Hornik, Friedrich Leisch and Achim Zeileis, editors, Proceedings of the 3rd International Workshop on Distributed Statistical Computing (DSC 2003), March 20-22, Vienna, Austria. \url{https://www.r-project.org/conferences/DSC-2003/Proceedings/}
 \cr
}
\keyword{package}
