rbefdata (version 0.3.5)

bef.portal.attach.to_proposal: Attach a freeformat file to a paper proposal

Description

This function attaches a freeformat file to a proposal

Usage

bef.portal.attach.to_proposal(id, attachment, description = "", is_paper = FALSE, doi = "", open_browser = FALSE, curl = getCurlHandle())

Arguments

id

The ID of the proposal you like to attach to. You can get the ID from the URL of the proposal.

attachment

Can be either a path to a file or an R data frame.

description

An optional description to your attachmed freeformat file.

curl

You can pass in a curl handle to reduce memory footprint and to add own options

is_paper

Just to tell the portal if it is a published paper you are attaching as pdf for example. This parameter can be TRUE or FALSE and defaults to FALSE.

doi

If the attachment has a persistent digital identifyer you can add it here.

open_browser

If this is set to true the page of the proposal is opened in the browser after successful upload. This defaults to FALSE.

Value

Returns a status message whether the update was successful or not.

Examples

## Not run: 
#   bef.portal.attach.to_proposal(id = 72, attachment = dataset, description = "This
#                is a pure test description for the new attachment file", open_browser = T)
#       ## End(Not run)