File: copyDirectory.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (46 lines) | stat: -rw-r--r-- 1,322 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  copyDirectory.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{copyDirectory}
\alias{copyDirectory.default}
\alias{copyDirectory}

\title{Copies a directory}

\description{
 Copies a directory.
}

\usage{
\method{copyDirectory}{default}(from, to=".", ..., private=TRUE, recursive=TRUE)
}

\arguments{
  \item{from}{The pathname of the source directory to be copied.}
  \item{to}{The pathname of the destination directory.}
  \item{...}{Additional arguments passed to
    \code{\link[base:files]{file.copy}}(), e.g. \code{overwrite}.}
  \item{private}{If \code{\link[base:logical]{TRUE}}, files (and directories) starting with
        a period is also copied, otherwise not.}
  \item{recursive}{If \code{\link[base:logical]{TRUE}}, subdirectories are copied too,
        otherwise not.}
}

\value{
  Returns (invisibly) a \code{\link[base]{character}} \code{\link[base]{vector}} of pathnames copied.
}

\details{
  Note that this method does \emph{not} use \code{\link{copyFile}}() to
  copy the files, but \code{\link[base]{file.copy}}().
}

\author{Henrik Bengtsson}


\keyword{file}