From db9ae6a0c9cecb92048fde6f06af1da183c09b5f Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Thu, 19 Nov 2020 15:41:24 +0100
Subject: Depend on parallel, doc improvements

By depending on parallel instead of importing it, functions to set up
and stop a cluster are always available when mkin is loaded.

The use of multicore processing in mmkin on Windows is now documented in
the help file, which brings mkin closer to a version 1.0 #9.
---
 R/mkinsub.R | 20 +-------------------
 1 file changed, 1 insertion(+), 19 deletions(-)

(limited to 'R/mkinsub.R')

diff --git a/R/mkinsub.R b/R/mkinsub.R
index f87c230a..886f712c 100644
--- a/R/mkinsub.R
+++ b/R/mkinsub.R
@@ -3,6 +3,7 @@
 #' This is a convenience function to set up the lists used as arguments for
 #' \code{\link{mkinmod}}.
 #' 
+#' @rdname mkinmod
 #' @param submodel Character vector of length one to specify the submodel type.
 #'   See \code{\link{mkinmod}} for the list of allowed submodel names.
 #' @param to Vector of the names of the state variable to which a
@@ -14,25 +15,6 @@
 #'   your R code will not be portable, \emph{i.e.} may produce unintended plot
 #'   results on other operating systems or system configurations.
 #' @return A list for use with \code{\link{mkinmod}}.
-#' @author Johannes Ranke
-#' @examples
-#' 
-#' # One parent compound, one metabolite, both single first order.
-#' SFO_SFO <- mkinmod(
-#'   parent = list(type = "SFO", to = "m1"),
-#'   m1 = list(type = "SFO"))
-#' 
-#' # The same model using mkinsub
-#' SFO_SFO.2 <- mkinmod(
-#'   parent = mkinsub("SFO", "m1"),
-#'   m1 = mkinsub("SFO"))
-#' 
-#' \dontrun{
-#'   # Now supplying full names
-#'   SFO_SFO.2 <- mkinmod(
-#'     parent = mkinsub("SFO", "m1", full_name = "Test compound"),
-#'     m1 = mkinsub("SFO", full_name = "Metabolite M1"))
-#'  }
 #' @export
 mkinsub <- function(submodel, to = NULL, sink = TRUE, full_name = NA)
 {
-- 
cgit v1.2.1