Rの関数dirとfile.copyの引数recursiveの挙動を確認

基本的な動作の違い

• recursive = FALSE （デフォルト）
  • 指定したパス（フォルダ）の直下にあるファイルやフォルダのみをリストアップします。サブフォルダの中身までは見に行きません。
• recursive = TRUE
  • 指定したパスの中にあるサブフォルダ、さらにその中のサブフォルダ…と、階層を一番下まで掘り下げてすべてのファイルを探し出します。

具体例

以下のようなフォルダ構造が手元にあるとします。

my_folder/
 ├── file_A.txt
 └── sub_folder/
      ├── file_B.txt
      └── file_C.csv

この my_folder に対して dir を実行した場合の違いは以下のようになります。

dir(path = "my_folder", recursive = FALSE)

[1] "file_A.txt"   "sub_folder"

dir(path = "my_folder", recursive = TRUE)

[1] "file_A.txt"            "sub_folder/file_B.txt" "sub_folder/file_C.csv"

dir(path = ".", pattern = "\\.csv$", recursive = TRUE)

# 完全なファイルパスとして取得する
csv_files <- dir(path = "my_folder", pattern = "\\.csv$", 
                 recursive = TRUE, full.names = TRUE)

# 上記指定で lapply 等を使って一括読み込みができるようになります
# data_list <- lapply(csv_files, read.csv)

基本的な動作の違い

• recursive = FALSE （デフォルト）
  • 「ファイル」しかコピーできません。
  • もし from（コピー元）にフォルダを指定した場合、ソースコードの以下の部分が働き、「フォルダはスキップされました」という警告（warning）が出てコピーされません。

warning("directories are omitted unless 'recursive = TRUE'")

• recursive = TRUE
  • 指定した「フォルダそのもの」と「その中に含まれるすべてのファイル・サブフォルダ」を丸ごとコピーします。

コピー先（to）は「既に存在する1つのフォルダ」である必要があります

以下は関数コードからの抜粋です。

else if (recursive) 
    warning("'recursive' will be ignored as 'to' is not a single existing directory")

recursive = TRUE を使ってフォルダごとコピーする場合、コピー先（to）はすでに作成されているフォルダ（ディレクトリ）を指定する必要があります。

存在しないフォルダ名や、複数の場所を指定すると、recursive は無視されてしまいます。（事前に 関数 dir.create 等でコピー先フォルダを作っておく必要があります）

overwrite（上書き）のデフォルト設定が変わります

以下は関数の引数定義です。

function (from, to, overwrite = recursive, recursive = FALSE, ...)

通常、file.copy は安全のため上書き保存しませんが、recursive = TRUE にすると、連動して overwrite = TRUE になります。

つまり、フォルダごとコピーした際、コピー先に同名のファイルがあった場合は問答無用で上書きされます。

上書きしたくない場合は、明示的に overwrite = FALSE を指定する必要があります。

自分自身の中へのコピー（無限ループ）の防止

以下は関数コードからの抜粋です。

if (recursive && to %in% from) 
    stop("attempt to copy a directory to itself")

フォルダを、そのフォルダ自身の中にコピーしようとすると無限ループになるため、エラー（stop）になるよう安全対策がされています。

具体例

以下のような状況を想定します。

• コピー元：project_A というフォルダ（中に複数のファイルやサブフォルダがある）
• コピー先：backup というフォルダ（既に作成済みとする）

file.copy(from = "project_A", to = "backup")

file.copy(from = "project_A", to = "backup", recursive = TRUE)