Retrieve and download files for a project

Source: R/retrieve-file-list.R

retrieve_file_list() retrieve the complete list of files to be copied into a new project, while download_file_list() copies the files to the destination_directory on your local maachine.

retrieve_file_list(
  offspring,
  project_name = "new-project",
  destination_directory = file.path("~", project_name)
)
download_file_list(
  offspring,
  project_name  = "new-project",
  destination_directory = file.path("~", project_name)
)

Arguments

offspring

character of observed values in the investigation. Required.

project_name

character of the new project. Defaults to new-project.

destination_directory

character of the files. Defaults to ~ (i.e, the home directory).

Value

Table of files to copy

Details

Currently, two types of project is supported:

  1. r-analysis-skeleton

  2. cdw-skeleton-1

Note

To view the files involved in each project type, refer to https://github.com/OuhscBbmc/pluripotent/inst/data/file-to-copy.csv. Each line represents one file that will be placed in the new project. The columns are

  1. offspring: the project type to be created.

  2. copy: indicator if the file should be copied. If FALSE, the file is ignored.

  3. destination: the file's location in the new project.

  4. source: the location where the file is copied from.

Author

Will Beasley

Examples

library(pluripotent)
d1 <- retrieve_file_list("r-analysis-skeleton")

if (FALSE) {
download_file_list("r-analysis-skeleton", "new-project", "./data-public/testing")
}