Re. issue #12 -- function releaseDataset to make a dataset public

Includes a version bump to 0.3.0 to reflect new function

Author: Timothée Poisot

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: rmangal
-Version: 0.2.1
+Version: 0.3.0
 Date: 2014-01-14
 Title: R interface to the mangal database of ecological networks
 Author: Tim Poisot <t.poisot@gmail.com>

NAMESPACE

@@ -38,6 +38,7 @@ export(patchPopulation)
 export(patchReference)
 export(patchTaxa)
 export(patchTrait)
+export(releaseDataset)
 export(toCheddar)
 export(toIgraph)
 export(whatIs)

NEWS

@@ -1,3 +1,7 @@
+rmangal 0.3.0
+=============
+* Added functions to release a dataset (and all objects attached to it)
+
 rmangal 0.2.1
 =============
 * Bug fix due to changes in how json objects are rendered by the parser

R/dataset_methods.R

@@ -51,4 +51,4 @@ patchDataset <- function(api, data)
 	if(!is.null(data$data)) data$data <- multi_resToURI(api, data$data, 'reference')
 	if(!is.null(data$environment)) data$environment <- multi_resToURI(api, data$environment, 'environment')
 	mangalPatch(api, 'dataset', data)
-}
+}

R/mangalPatch.R

@@ -1,4 +1,4 @@
-#' Patch an object
+#' @title Patch an object
 #'
 #' Patch an existing object
 #'

R/release_dataset.R

@@ -0,0 +1,43 @@
+#' @title Release a resource
+#' @description 
+#' This function is used internally to release a resource. It do not returns
+#' anything, but throws a warning if there is no public field to update.
+releaseResource <- function(api, type, id)
+{
+   resource <- mangalGet(api, type, id)
+   if(is.null(resource$public))
+   {
+      warning(str_c("The resource ", type, '/', id, " has no public field"))
+   } else {
+      resource$public <- TRUE
+      mangalPatch(api, type, resource)
+   }
+}
+
+#' @title Release a dataset
+#' @description 
+#' Releases a dataset, and all objects of lower level (networks and 
+#' interactions).
+#'
+#' @param api a \code{\link{mangalapi}} object
+#' @param id the id of the dataset to release
+#' @param force whether to force release even if the dataset is already public
+#' 
+#' @export
+releaseDataset <- function(api, id, force=FALSE)
+{
+   dataset <- getDataset(api, id)
+   if(dataset$public & (! force)) stop("This dataset is already public") 
+   # We go through 1) the list of networks, 2) the list of interactions
+   for(net_id in dataset$networks)
+   {
+      net <- getNetwork(api, net_id)
+      releaseResource(api, 'network', net_id)
+      for(int_id in net$interactions)
+      {
+         releaseResource(api, 'interaction', int_id)
+      }
+   }
+   releaseResource(api, 'dataset', id)
+}
+

man/mangalPatch.Rd

@@ -1,6 +1,8 @@
 \name{mangalPatch}
 \alias{mangalPatch}
-\title{Patch an object}
+\title{Patch an object
+
+Patch an existing object}
 \usage{
 mangalPatch(api, type, data)
 }
@@ -12,6 +14,8 @@ mangalPatch(api, type, data)
   \item{data}{the object in list form}
 }
 \description{
+Patch an object
+
 Patch an existing object
 }
 

man/releaseDataset.Rd

@@ -0,0 +1,19 @@
+\name{releaseDataset}
+\alias{releaseDataset}
+\title{Release a dataset}
+\usage{
+releaseDataset(api, id, force = FALSE)
+}
+\arguments{
+  \item{api}{a \code{\link{mangalapi}} object}
+
+  \item{id}{the id of the dataset to release}
+
+  \item{force}{whether to force release even if the dataset
+  is already public}
+}
+\description{
+Releases a dataset, and all objects of lower level
+(networks and interactions).
+}
+

man/releaseResource.Rd

@@ -0,0 +1,12 @@
+\name{releaseResource}
+\alias{releaseResource}
+\title{Release a resource}
+\usage{
+releaseResource(api, type, id)
+}
+\description{
+This function is used internally to release a resource. It
+do not returns anything, but throws a warning if there is
+no public field to update.
+}
+