download_pt_files: download_pt_files - Download reports or associated files from...

In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal

download_pt_files - Download reports or associated files from project tracker

Description

This is a utility function that is used by both fetch_pt_reports() and fetch_pt_associated_files() to actually download the files they return. The download logic is sufficiently similar for both function that it makes to encapsulate it in a single helper function. This function takes a dataframe that contains a list of reports or associated file name/path. The file name must be the last column in the data frame. Each report or file listed in the dataframe is downloaded into the target directory. If create_target_dir is True, and the target directory does not exist it will be created. If xlsx_toc is true, an associated xlsx file will be created in the target directory - the spreadsheet will contain all of the fields contained in the file list, and a hyperlink to each of the downloaded files.

Usage

download_pt_files(
  file_list,
  target_dir,
  xlsx_toc = "reports_toc.xlsx",
  create_target_dir = TRUE
)

Arguments

file_list	dataframe - containing the contents to be written into the toc. The last column of which is expected to be the path the report or associated file on project tracker.
target_dir	string - the directory where the files will be copied
xlsx_toc	the name of the excel table of contents file to be created in the target directory. A toc is only produced if this argument ends in 'xlsx'.
create_target_dir	boolean should the target directory be created if it does not already exist

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

AdamCottrill/glfishr documentation built on Aug. 9, 2024, 5:47 p.m.