soft: Post a file to SOFT for sharing

View source: R/soft.R

softR Documentation

Post a file to SOFT for sharing

Description

Files can be shared from within the government network, from a government user to the public, or from the public to a government user. Public-to-public sharing is not supported. A user can specify the number of days the file will be available, and whether or not to restrict access to the file to within the governmnet network.

Usage

soft(
  file,
  email = NULL,
  email_subj = NULL,
  internal = TRUE,
  days = 7,
  progress = TRUE,
  zip = FALSE,
  zipname = NULL
)

Arguments

file

Path to the file or directory on your computer. If file is a directory or a character vector of filenames, the files in the directory will be zipped before they are uploaded.

email

Optional email address to which to send the link to the file.

email_subj

Optional subject of the email.

internal

Should the link be only available with the B.C. Government network? Default TRUE

days

The number of days the file should be available. Default 7, maximum 14.

progress

Should a progress bar be displayed? Default TRUE.

zip

Should the file be zipped before sending? Default FALSE, however it file is a directory or multiple files they will be zipped anyway.

zipname

an option name to call the zipfile. If left NULL (default), a name will be generated.

Details

The SOFT web form and more information can be found here.

Value

A url of the link from which the file can be downloaded


bcgov/envreportutils documentation built on Feb. 1, 2024, 8:48 p.m.