From f46567907833c6fe85de8ef9cf65a4f58801f396 Mon Sep 17 00:00:00 2001
From: aheinri5 <Anna@netzkritzler.de>
Date: Wed, 25 Nov 2020 22:01:05 +0100
Subject: [PATCH] [docs] Updated documentation

---
 man/as_node.r2ogs6_mesh.Rd       | 14 ++++++++++++++
 man/construct_add_call.Rd        | 21 +++++++++++++++++++++
 man/generate_benchmark_script.Rd | 16 ++++++++++++++++
 man/r2ogs6_mesh.Rd               | 14 ++++++++++++++
 man/validate_paths.Rd            |  2 +-
 5 files changed, 66 insertions(+), 1 deletion(-)
 create mode 100644 man/as_node.r2ogs6_mesh.Rd
 create mode 100644 man/construct_add_call.Rd
 create mode 100644 man/generate_benchmark_script.Rd
 create mode 100644 man/r2ogs6_mesh.Rd

diff --git a/man/as_node.r2ogs6_mesh.Rd b/man/as_node.r2ogs6_mesh.Rd
new file mode 100644
index 0000000..bbff2b3
--- /dev/null
+++ b/man/as_node.r2ogs6_mesh.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/vtu.R
+\name{as_node.r2ogs6_mesh}
+\alias{as_node.r2ogs6_mesh}
+\title{as_node.r2ogs6_curve}
+\usage{
+\method{as_node}{r2ogs6_mesh}(x)
+}
+\arguments{
+\item{x}{A r2ogs6_mesh class object}
+}
+\description{
+Implementation of generic function as_node for S3 class r2ogs6_mesh
+}
diff --git a/man/construct_add_call.Rd b/man/construct_add_call.Rd
new file mode 100644
index 0000000..76831c7
--- /dev/null
+++ b/man/construct_add_call.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/generate_benchmark_script.R
+\name{construct_add_call}
+\alias{construct_add_call}
+\title{construct_add_call}
+\usage{
+construct_add_call(object, nested_call = FALSE)
+}
+\arguments{
+\item{object}{An object (numeric, character, list, NULL, or r2ogs6 class object)}
+
+\item{nested_call}{Optional: For recursion purposes, you should leave this as it is.}
+}
+\value{
+A string representing the code with which the component would be added
+to an OGS6 object
+}
+\description{
+Constructs a call based on an OGS6 component. This is a recursive function
+and its feelings are easily hurt. Please handle it with care.
+}
diff --git a/man/generate_benchmark_script.Rd b/man/generate_benchmark_script.Rd
new file mode 100644
index 0000000..f419292
--- /dev/null
+++ b/man/generate_benchmark_script.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/generate_benchmark_script.R
+\name{generate_benchmark_script}
+\alias{generate_benchmark_script}
+\title{generate_benchmark_script}
+\usage{
+generate_benchmark_script(prj_path, dest_dir = "")
+}
+\arguments{
+\item{prj_path}{The path to the project file the script will be based on}
+
+\item{dest_dir}{Optional: The directory to write the script to}
+}
+\description{
+Generates a benchmark script from an existing .prj file.
+}
diff --git a/man/r2ogs6_mesh.Rd b/man/r2ogs6_mesh.Rd
new file mode 100644
index 0000000..7bf23df
--- /dev/null
+++ b/man/r2ogs6_mesh.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/vtu.R
+\name{r2ogs6_mesh}
+\alias{r2ogs6_mesh}
+\title{r2ogs6_mesh}
+\usage{
+r2ogs6_mesh(mesh_ref)
+}
+\arguments{
+\item{mesh_ref}{A reference to a .vtu file}
+}
+\description{
+Wrapper class, so far only has a reference to a .vtu file
+}
diff --git a/man/validate_paths.Rd b/man/validate_paths.Rd
index b0f53ae..1ad4c8f 100644
--- a/man/validate_paths.Rd
+++ b/man/validate_paths.Rd
@@ -1,5 +1,5 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/utils.R
+% Please edit documentation in R/sim_utils.R
 \name{validate_paths}
 \alias{validate_paths}
 \title{validate_paths}
-- 
GitLab