rmDS {dsBase}R Documentation

rmDS an aggregate function called by ds.rm

Description

deletes an R object on the serverside

Usage

rmDS(x.name.transmit)

Arguments

x.name.transmit,

the name of the object to be deleted converted into transmissable form. The argument is specified via the <x.name> argument of ds.rm

Details

this is a serverside function based on the rm() function in native R. It is an aggregate function which may be surprising because it modifies an object on the serverside, and would therefore be expected to be an assign function. However, as an assign function the last step in running it would be to write the modified object as newobj. But this would fail because the effect of the function is to delete the object and so it would be impossible to write it anywhere.

Value

the specified object is deleted from the serverside. If this is successful the message "Object <x.name> successfully deleted" is returned to the clientside (where x.name is the name of the object to be deleted). If the object to be deleted is already absent on a given source, that source will return the message: "Object to be deleted, i.e. <x.name> , does not exist so does not need deleting". Finally, if the specified name of the object to be deleted is too long (>nfilter.stringShort) there is a potential disclosure risk (active code hidden in the name) and the rmDS returns a message such as: "Disclosure risk, number of characters in x.name must not exceed nfilter.stringShort which is currently set at: 25" where '25' is the current setting of the R_Option value of nfilter.stringShort.

Author(s)

Paul Burton for DataSHIELD Development Team


[Package dsBase version 5.0.0 ]