deleteFiles

deleteFiles.redcapDbConnection

deleteFiles.redcapApiConnection

A REDCap connection object as generated by <code>redcapConnection</code>

rcon

The record ID in which the desired file is stored. Must be length 1.

record

The field name in which the file is stored. Must be length 1.

field

The event name for the file. Must be length 1.
This applies only to longitudinal projects. If the event is not
supplied for a longitudinal project, the API will return an error message.

event

Arguments to be passed to other methods

A <code>redcapBundle</code> object as created by <code>exportBundle</code>.

bundle

An option for how to handle errors returned by the API.
see <code><a rd-options="" href="/link/redcap_error?package=redcapAPI&version=2.3" data-mini-rdoc="redcapAPI::redcap_error">redcap_error</a></code>

error_handling

This function allows you to remove a document that has been 
attached to an individual record

Access data stored in 'REDCap' databases using the Application
Programming Interface (API). 'REDCap' (Research Electronic Data CAPture;
<https://projectredcap.org>) is
a web application for building and managing online surveys and databases
developed at Vanderbilt University. The API allows users to access data
and project meta data (such as the data dictionary) from the web
programmatically. The 'redcapAPI' package facilitates the process of
accessing data with options to prepare an analysis-ready data set
consistent with the definitions in a database's data dictionary.

Benjamin Nutter

redcapAPI

Interface to 'REDCap'

Stephen Lane

Will Beasley

Jeffrey Horner

Will Gray

Jeremy Stephens

Marcus Lehr

deleteFiles function

<dl><dt>rcon</dt>
<dd>A REDCap connection object as generated by <code>redcapConnection</code></dd>
<dt>record</dt>
<dd>The record ID in which the desired file is stored. Must be length 1.</dd>
<dt>field</dt>
<dd>The field name in which the file is stored. Must be length 1.</dd>
<dt>event</dt>
<dd>The event name for the file. Must be length 1.
This applies only to longitudinal projects. If the event is not
supplied for a longitudinal project, the API will return an error message.</dd>
<dt>...</dt>
<dd>Arguments to be passed to other methods</dd>
<dt>bundle</dt>
<dd>A <code>redcapBundle</code> object as created by <code>exportBundle</code>.</dd>
<dt>error_handling</dt>
<dd>An option for how to handle errors returned by the API.
see <code>redcap_error</code></dd></dl>

Arguments

Author

Delete a File attached to a Record — deleteFiles

<dl>

<dt>rcon</dt>
<dd>A REDCap connection object as generated by <code>redcapConnection</code></dd>


<dt>record</dt>
<dd>The record ID in which the desired file is stored. Must be length 1.</dd>


<dt>field</dt>
<dd>The field name in which the file is stored. Must be length 1.</dd>


<dt>event</dt>
<dd>The event name for the file. Must be length 1.
This applies only to longitudinal projects. If the event is not
supplied for a longitudinal project, the API will return an error message.</dd>


<dt>...</dt>
<dd>Arguments to be passed to other methods</dd>


<dt>bundle</dt>
<dd>A <code>redcapBundle</code> object as created by <code>exportBundle</code>.</dd>


<dt>error_handling</dt>
<dd>An option for how to handle errors returned by the API.
see <code>redcap_error</code></dd>

</dl>

deleteFiles: Delete a File attached to a Record

Description

Usage

Arguments

Author

References