Merge pull request #58 from syncrosim/vignetteUpdate

vignette addition and dependency help update

R/dependency.R

@@ -3,7 +3,7 @@
 #' @include AAAClassDefinitions.R
 NULL
 
-#' Get, set or remove Scenario dependency(s)
+#' Get, set or remove Scenario dependencies
 #' 
 #' List dependencies, set dependencies, or remove dependencies from a SyncroSim
 #' \code{\link{Scenario}}. Setting dependencies is a way of linking together
@@ -16,20 +16,21 @@ NULL
 #' is returned in order of precedence (from highest to lowest precedence).
 #' Otherwise, returns list of saved or error messages for each dependency of each 
 #' scenario.
+#' 
+#' Note that pre-existing dependencies will be removed when adding new dependencies unless
+#' those elements are included in the vector of new dependencies.
 #'
-#' Note that the order of dependencies can be important - dependencies added most 
-#' recently take precedence over existing dependencies. So, dependencies included 
-#' in the dependency argument take precedence over any other existing dependencies. 
-#' If the dependency argument includes more than one element, elements are ordered 
-#' from lowest to highest precedence.
 #'
 #' @param ssimObject \code{\link{Scenario}} object, character string, integer, or 
 #' vector of these. The Scenario object, name, or ID to which a dependency is to 
 #' be added (or has already been added if \code{remove=TRUE}). Note that integer ids 
 #' are slightly faster.
+#' 
 #' @param value \code{\link{Scenario}} object, character string, integer, or 
 #' vector of these. The Scenario object, name, or ID to be used as the 
-#' dependency. If an empty vector is provided, all dependencies are removed.
+#' dependency. If an empty vector is provided, all dependencies are removed. If 
+#' multiple elements are provided, elements should be ordered from highest to lowest
+#' precedence.
 #' 
 #' @return 
 #' A data.frame: all dependencies for a given Scenario
@@ -84,7 +85,7 @@ setMethod("dependency", signature(ssimObject = "Scenario"), function(ssimObject)
   names(dependencySet)[names(dependencySet) == "Id"] <- "ScenarioId"
 
   return(dependencySet)
-  }
+}
 )
 
 #' @rdname dependency
@@ -172,7 +173,7 @@ setReplaceMethod(
         stop(tt)
       }
     }
-
+    
     return(ssimObject)
   }
 )