Commit 7be70acb authored by Dorchies David's avatar Dorchies David
Browse files

docs: minor enhancements

Showing with 12 additions and 5 deletions
+12 -5
...@@ -16,7 +16,7 @@ Suggests: ...@@ -16,7 +16,7 @@ Suggests:
Config/testthat/edition: 3 Config/testthat/edition: 3
Depends: Depends:
R (>= 2.10) R (>= 2.10)
RoxygenNote: 7.1.1 RoxygenNote: 7.1.2
Roxygen: list(markdown = TRUE) Roxygen: list(markdown = TRUE)
Imports: Imports:
logger, logger,
......
#' 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, ...)` #' @param params a [list] of [character] containing the parameters to send to the fortran program with format `list(param=value, ...)`
#' @template param_cfg #' @template param_cfg
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
% Please edit documentation in R/convert_sic_params.R % Please edit documentation in R/convert_sic_params.R
\name{convert_sic_params} \name{convert_sic_params}
\alias{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{ \usage{
convert_sic_params(params, cfg = loadConfig()) convert_sic_params(params, cfg = loadConfig())
} }
...@@ -15,7 +15,10 @@ 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. A \link{character} with each parameter is converted to \verb{[key param]=[value param]} and each parameter separated by a space character.
} }
\description{ \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{ \examples{
convert_sic_param(list(SCE = 1, VAR = 1)) convert_sic_param(list(SCE = 1, VAR = 1))
......
...@@ -51,7 +51,7 @@ Configuration of RSIC2 as the following structure: ...@@ -51,7 +51,7 @@ Configuration of RSIC2 as the following structure:
Read default configuration of the package and complete it with eventual user config Read default configuration of the package and complete it with eventual user config
} }
\details{ \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 path: Path/To/SIC/installation
project: project:
path: Path/To/Xml/Project/File.xml path: Path/To/Xml/Project/File.xml
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment