R/999.package.R

In HenrikBengtsson/R.archive: Automatic Copying of Objects and Files to a File-based Archive

#########################################################################/**
# @RdocPackage R.archive
#
# \description{
#   @eval "getDescription(R.archive)"
# }
#
# \section{Requirements}{
#   This package requires the \pkg{R.utils} package [1].
# } 
#
# \section{Installation and updates}{
#
#   To install this package do:\cr
#
#   \code{install.packages("R.archive")}
# } 
#
# \section{To get started}{
#   \itemize{
#    \item To \emph{manually} archive an existing file by adding a timestamped
#      copy of it to the archive directory, see \code{\link{archiveFile}()}.
#    \item To \emph{automatically} archive all of your image files,
#       (i) load this package,
#       (ii), create them using the methods in \pkg{R.devices}, and
#       (iii) enable archiving by \code{setArchiveOption("devEval", TRUE)}.
#      For more details, see @see "setArchiveOption".
#   }
# }
#
# \section{How to cite this package}{
#   Whenever using this package, please cite [1] as
#
#   @howtocite "R.oo"
# }
#
# @author
#
# \section{License}{
#   The releases of this package is licensed under 
#   LGPL version 2.1 or newer.
#
#   The development code of the packages is under a private licence 
#   (where applicable) and patches sent to the author fall under the
#   latter license, but will be, if incorporated, released under the
#   "release" license above.
# }
#
# \section{References}{
# [1] @include "../incl/BengtssonH_2003.bib.Rdoc" \cr
# }
#*/#########################################################################