[docs] Updating documentation

man/guess_structure.Rd

@@ -7,16 +7,16 @@
 guess_structure(xml_node, xpath_expr, subclasses_names = character())
 }
 \arguments{
-\item{xml_node}{An XML node (of class xml2::xml_node)}
+\item{xml_node}{xml2::xml_node: XML node}
 
-\item{xpath_expr}{An XPath expression (for subclass differentiation)}
+\item{xpath_expr}{string: XPath expression (for subclass differentiation)}
 
-\item{subclasses_names}{Optional: A character vector containing the names of
-r2ogs6 subclasses (r2ogs6 classes without a method for input_add)}
+\item{subclasses_names}{Optional: character: Names of r2ogs6 subclasses
+(r2ogs6 classes without a OGS6$add method)}
 }
 \description{
 Guesses the R representation of an XML node and adds it to
-parameter list
+parameter list. This is a recursive function.
 ASSUMPTIONS:
 1) Leaf nodes will have EITHER a value OR attributes (and will not be missing
 both, e.g. '<a/>').

man/r2ogs6_time_stepping.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/prj_time_loop.R
+\name{r2ogs6_time_stepping}
+\alias{r2ogs6_time_stepping}
+\title{r2ogs6_time_stepping}
+\usage{
+r2ogs6_time_stepping(
+  type,
+  t_initial = NULL,
+  t_end = NULL,
+  timesteps = NULL,
+  initial_dt = NULL,
+  minimum_dt = NULL,
+  maximum_dt = NULL,
+  number_iterations = NULL,
+  multiplier = NULL,
+  dt_guess = NULL,
+  dt_min = NULL,
+  dt_max = NULL,
+  rel_dt_min = NULL,
+  rel_dt_max = NULL,
+  tol = NULL
+)
+}
+\arguments{
+\item{type}{string:}
+
+\item{t_initial}{Optional: string | double:}
+
+\item{t_end}{Optional: string | double:}
+
+\item{timesteps}{Optional: list:}
+
+\item{initial_dt}{Optional: string | double:}
+
+\item{minimum_dt}{Optional: string | double:}
+
+\item{maximum_dt}{Optional: string | double:}
+
+\item{number_iterations}{Optional: string | numeric:}
+
+\item{multiplier}{Optional: string | numeric:}
+
+\item{dt_guess}{Optional: string | double:}
+
+\item{dt_min}{Optional: string | double:}
+
+\item{dt_max}{Optional: string | double:}
+
+\item{rel_dt_min}{Optional: string | double:}
+
+\item{rel_dt_max}{Optional: string | double:}
+
+\item{tol}{Optional: string | double:}
+}
+\description{
+tag: time_stepping
+}

man/r2ogs6_tl_process.Rd

@@ -22,7 +22,7 @@ r2ogs6_tl_process(
 
 \item{time_discretization}{vector:}
 
-\item{time_stepping}{list:}
+\item{time_stepping}{r2ogs6_time_stepping:}
 
 \item{compensate_non_equilibrium_initial_residuum}{string: Optional: Either
 "true" or "false"}

man/read_in_output.Rd

@@ -10,6 +10,7 @@ read_in_output(ogs6_obj)
 \item{ogs6_obj}{A OGS6 class object}
 }
 \description{
-After a OGS6 simulation was run, reads in the generated .vtu files as new input for
+After a OGS6 simulation was run, reads in the generated .vtu
+files as new input for
 the .prj file
 }

man/run_simulation.Rd

@@ -14,5 +14,6 @@ run_simulation(ogs6_obj, iter_n = 1, output_to_log_file = TRUE)
 \item{output_to_log_file}{Should the output be written to a log file?}
 }
 \description{
-Calls OGS6 object validator functions, exports all necessary files and starts OpenGeoSys6
+Calls OGS6 object validator functions, exports all necessary
+files and starts OpenGeoSys6
 }

man/validate_is_dir_path.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{validate_is_dir_path}
+\alias{validate_is_dir_path}
+\title{validate_is_dir_path}
+\usage{
+validate_is_dir_path(path)
+}
+\arguments{
+\item{path}{string: A path}
+}
+\description{
+Checks if a given path ends on '/'
+}