% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/archiveFolders.R
\name{ArchiveFolders}
\alias{ArchiveFolders}
\title{Archives Html, Txt, and IndexHtml folders in .tar.gz files.}
\usage{
ArchiveFolders(project = NULL, website = NULL, removeArchivedFolders = FALSE)
}
\arguments{
\item{project}{Name of 'castarter' project. Must correspond to the name of a folder in the current working directory.}

\item{website}{Name of a website included in a 'castarter' project. Must correspond to the name of a sub-folder of the project folder.}

\item{removeArchivedFolders}{If equal to TRUE, it removes the folders and the original html and txt files from the hard disk, after having archived them.}
}
\description{
It archives  Html, Txt, and IndexHtml folders in .tar.gz files, and stores them in a dated sub-folder within the Archives sub-folder.
}
\section{Warning}{

If the option removeArchivedFolders is enabled, the function actually deletes files from the hard disk. Files are removed only after they have been successfully stored in compressed .tar.gz file, but it is recommended to backup valuable data before enabling this option.
}

\examples{
\dontrun{
ArchiveFolders(project, website, removeArchivedFolders = FALSE)
}
}
