experimentUnpublish: experimentUnpublish Unpublishes an experiment.

In ajwtech/pfsrsdk: Functions for interacting with Platform for Science APIs

Description

experimentUnpublish - Unpublishes an experiment.

Usage

experimentUnpublish(coreApi, experimentType, experimentBarcode,
  useVerbose = FALSE)

Arguments

coreApi	coreApi object with valid jsessionid
experimentType	experiment entity type
experimentBarcode	barcode of the experiment (Experiments that require a signature cannot be published through the API).
useVerbose	Use verbose communication for debugging

Details

experimentUnpublish Unpublishes an experiment.

Value

RETURN returns a list $entity contains updated experiment information, $response contains the entire http response For PFS version 5.x.x the output is generate as list(entity = httr::content(response)$response$data, response = response) For PFS version 6.x.x the output is generate as list(entity = httr::content(response), response = response)

Author(s)

Craig Parman [e-mail]

Natasha Mora [e-mail]

Examples

## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
update <- experimentUnpublish(login$coreApi, experimentType, experimentBarcode, useVerbose = TRUE)
logOut(login$coreApi)

## End(Not run)

ajwtech/pfsrsdk documentation built on June 14, 2019, 10:34 a.m.