From 629f1b3eec63c8c0a6a620cf40a73f3989c78649 Mon Sep 17 00:00:00 2001
From: David <david.dorchies@inrae.fr>
Date: Tue, 2 Apr 2024 14:12:54 +0200
Subject: [PATCH] docs: Remove RunModel.SD from exported functions
---
NAMESPACE | 1 -
R/CreateController.R | 2 +-
R/RunModel.SD.R | 2 +-
man/RunModel.SD.Rd | 29 -----------------------------
4 files changed, 2 insertions(+), 32 deletions(-)
delete mode 100644 man/RunModel.SD.Rd
diff --git a/NAMESPACE b/NAMESPACE
index 5189e7d..a53032b 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -21,7 +21,6 @@ S3method(CreateRunOptions,character)
S3method(RunModel,GR)
S3method(RunModel,GRiwrmInputsModel)
S3method(RunModel,InputsModel)
-S3method(RunModel,SD)
S3method(RunModel,Supervisor)
S3method(isNodeDownstream,GRiwrm)
S3method(isNodeDownstream,GRiwrmInputsModel)
diff --git a/R/CreateController.R b/R/CreateController.R
index 6cad87f..7199cd3 100644
--- a/R/CreateController.R
+++ b/R/CreateController.R
@@ -50,7 +50,7 @@ CreateController <- function(supervisor, ctrl.id, Y, U, FUN){
if(!is.null(supervisor$controllers[[ctrl.id]])) {
warning("The existing controller '", ctrl.id, "' has been overwritten in the supervisor")
} else {
- message("The controller has been added to the supervisor")
+ message("The controller '", ctrl.id, "' has been added to the supervisor")
}
supervisor$controllers[[ctrl.id]] <- ctrlr
invisible(ctrlr)
diff --git a/R/RunModel.SD.R b/R/RunModel.SD.R
index 5f8b781..6aa056b 100644
--- a/R/RunModel.SD.R
+++ b/R/RunModel.SD.R
@@ -5,7 +5,7 @@
#' @param ... further arguments passed to or from other methods
#'
#' @return `OutputsModel` object. See [airGR::RunModel_Lag]
-#' @export
+#' @noRd
#'
RunModel.SD <- function(x, RunOptions, Param, QcontribDown, ...) {
if (x$isReservoir) {
diff --git a/man/RunModel.SD.Rd b/man/RunModel.SD.Rd
deleted file mode 100644
index 161bb47..0000000
--- a/man/RunModel.SD.Rd
+++ /dev/null
@@ -1,29 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/RunModel.SD.R
-\name{RunModel.SD}
-\alias{RunModel.SD}
-\title{Run a semi-distributed model from rainfall-runoff model outputs}
-\usage{
-\method{RunModel}{SD}(x, RunOptions, Param, QcontribDown, ...)
-}
-\arguments{
-\item{x}{[object of class \code{InputsModel}] used as \code{InputsModel} parameter for \link[airGR:RunModel_Lag]{airGR::RunModel_Lag}}
-
-\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link[airGR]{CreateRunOptions}} for details}
-
-\item{Param}{[numeric] vector of 1 parameter
- \tabular{ll}{
- Velocity \tab mean flow velocity [m/s]
- }
- }
-
-\item{QcontribDown}{[numeric] vector or [OutputsModel] containing the time series of the runoff contribution of the downstream sub-basin}
-
-\item{...}{further arguments passed to or from other methods}
-}
-\value{
-\code{OutputsModel} object. See \link[airGR:RunModel_Lag]{airGR::RunModel_Lag}
-}
-\description{
-Run a semi-distributed model from rainfall-runoff model outputs
-}
--
GitLab