From 7be70acb391eeb7fb90cd1176349d8e6798193f9 Mon Sep 17 00:00:00 2001 From: Dorchies David <david.dorchies@inrae.fr> Date: Mon, 28 Feb 2022 16:09:29 +0100 Subject: [PATCH] docs: minor enhancements --- DESCRIPTION | 2 +- R/convert_sic_params.R | 6 +++++- man/convert_sic_params.Rd | 7 +++++-- man/loadConfig.Rd | 2 +- 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 13d2eb2..774286d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -16,7 +16,7 @@ Suggests: Config/testthat/edition: 3 Depends: R (>= 2.10) -RoxygenNote: 7.1.1 +RoxygenNote: 7.1.2 Roxygen: list(markdown = TRUE) Imports: logger, diff --git a/R/convert_sic_params.R b/R/convert_sic_params.R index a911e71..9ec3643 100644 --- a/R/convert_sic_params.R +++ b/R/convert_sic_params.R @@ -1,4 +1,8 @@ -#' Convert a list of parameters into command line arguments +#' Convert a list of parameters into command line arguments for Fortran SIC programs +#' +#' This function is called by [sic_run_fortran] to convert list of parameters into a [character] command line parameters. +#' +#' The parameter `INTERF` is set to 0 (zero) by default. #' #' @param params a [list] of [character] containing the parameters to send to the fortran program with format `list(param=value, ...)` #' @template param_cfg diff --git a/man/convert_sic_params.Rd b/man/convert_sic_params.Rd index 73f1d04..f41705e 100644 --- a/man/convert_sic_params.Rd +++ b/man/convert_sic_params.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/convert_sic_params.R \name{convert_sic_params} \alias{convert_sic_params} -\title{Convert a list of parameters into command line arguments} +\title{Convert a list of parameters into command line arguments for Fortran SIC programs} \usage{ convert_sic_params(params, cfg = loadConfig()) } @@ -15,7 +15,10 @@ convert_sic_params(params, cfg = loadConfig()) A \link{character} with each parameter is converted to \verb{[key param]=[value param]} and each parameter separated by a space character. } \description{ -Convert a list of parameters into command line arguments +This function is called by \link{sic_run_fortran} to convert list of parameters into a \link{character} command line parameters. +} +\details{ +The parameter \code{INTERF} is set to 0 (zero) by default. } \examples{ convert_sic_param(list(SCE = 1, VAR = 1)) diff --git a/man/loadConfig.Rd b/man/loadConfig.Rd index 76e890f..0e76006 100644 --- a/man/loadConfig.Rd +++ b/man/loadConfig.Rd @@ -51,7 +51,7 @@ Configuration of RSIC2 as the following structure: Read default configuration of the package and complete it with eventual user config } \details{ -The path to SIC and to the XML project file can be defined in the user XML file by defining the appropriate items:\if{html}{\out{<div class="yaml">}}\preformatted{sic: +The path to SIC and to the XML project file can be defined in the user XML file by defining the appropriate items:\if{html}{\out{<div class="sourceCode yaml">}}\preformatted{sic: path: Path/To/SIC/installation project: path: Path/To/Xml/Project/File.xml -- GitLab