diff --git a/R/extendr-wrappers.R b/R/extendr-wrappers.R index c7c3b3552..a2ae2137f 100755 --- a/R/extendr-wrappers.R +++ b/R/extendr-wrappers.R @@ -50,6 +50,8 @@ dummy_compile <- function(template_path) .Call(wrap__dummy_compile, template_pat is_cargo_installed <- function() .Call(wrap__is_cargo_installed) #' Fits the model at the given path to the data at the given path using the provided parameters. +#' NOTE: This is an internal function and should not be called directly. +#' See [PM_model()] `$fit()` method for arguments. #' @param model_path Path to the compiled model file. #' @param data Path to the data file. #' @param params List of fitting parameters. diff --git a/man/fit.Rd b/man/fit.Rd index 443b982f7..f6bd1cf36 100644 --- a/man/fit.Rd +++ b/man/fit.Rd @@ -2,7 +2,9 @@ % Please edit documentation in R/extendr-wrappers.R \name{fit} \alias{fit} -\title{Fits the model at the given path to the data at the given path using the provided parameters.} +\title{Fits the model at the given path to the data at the given path using the provided parameters. +NOTE: This is an internal function and should not be called directly. +See \link{PM_model} \verb{$fit()} method for arguments.} \usage{ fit(model_path, data, params, output_path, kind) } @@ -22,4 +24,6 @@ Result of the fitting process. } \description{ Fits the model at the given path to the data at the given path using the provided parameters. +NOTE: This is an internal function and should not be called directly. +See \link{PM_model} \verb{$fit()} method for arguments. } diff --git a/src/rust/src/lib.rs b/src/rust/src/lib.rs index d280ceff1..99f28f790 100755 --- a/src/rust/src/lib.rs +++ b/src/rust/src/lib.rs @@ -117,8 +117,9 @@ fn simulate_all( rows.into_dataframe().unwrap() } - /// Fits the model at the given path to the data at the given path using the provided parameters. +/// #' NOTE: This is an internal function and should not be called directly. +/// #' See [PM_model()] `$fit()` method for arguments. /// @param model_path Path to the compiled model file. /// @param data Path to the data file. /// @param params List of fitting parameters. @@ -307,4 +308,4 @@ extendr_module! { // To generate the exported function in R, run the following command: // rextendr::document() // Optional: reload Pmetrics -// devtools::load_all() \ No newline at end of file +// devtools::load_all()