From 66c7e9dbf1c9fa4ca55f1237b377f3a3f718f1e8 Mon Sep 17 00:00:00 2001
From: aheinri5 <Anna@netzkritzler.de>
Date: Thu, 19 Nov 2020 23:08:12 +0100
Subject: [PATCH] Added documentation for new functions
---
man/check_file_extension.Rd | 16 ++++++++++++
man/generate_as_node_func.Rd | 25 +++++++++++++++++++
man/generate_as_node_method_content.Rd | 22 +++++++++++++++++
man/generate_simple_read_in.Rd | 26 ++++++++++++++++++++
man/get_value_types.Rd | 16 ++++++++++++
man/guess_structure.Rd | 25 +++++++++++++++++++
man/node_to_r2ogs6_obj.Rd | 17 +++++++++++++
man/order_parameters.Rd | 16 ++++++++++++
man/pick_vtu_file.Rd | 14 +++++++++++
man/read_in.Rd | 34 ++++++++++++++++++++++++++
man/read_in_curves.Rd | 18 ++++++++++++++
man/read_in_gml.Rd | 16 ++++++++++++
man/read_in_linear_solvers.Rd | 18 ++++++++++++++
man/read_in_media.Rd | 18 ++++++++++++++
man/read_in_nonlinear_solvers.Rd | 18 ++++++++++++++
man/read_in_parameters.Rd | 18 ++++++++++++++
man/read_in_points.Rd | 14 +++++++++++
man/read_in_polylines.Rd | 14 +++++++++++
man/read_in_prj.Rd | 16 ++++++++++++
man/read_in_process_variables.Rd | 18 ++++++++++++++
man/read_in_processes.Rd | 18 ++++++++++++++
man/read_in_surfaces.Rd | 14 +++++++++++
man/read_in_test_definition.Rd | 18 ++++++++++++++
man/read_in_time_loop.Rd | 16 ++++++++++++
man/read_in_vtu.Rd | 16 ++++++++++++
man/strings_equal.Rd | 14 +++++++++++
man/validate_read_in_xml.Rd | 17 +++++++++++++
man/vector_from_nodeset.Rd | 14 +++++++++++
28 files changed, 506 insertions(+)
create mode 100644 man/check_file_extension.Rd
create mode 100644 man/generate_as_node_func.Rd
create mode 100644 man/generate_as_node_method_content.Rd
create mode 100644 man/generate_simple_read_in.Rd
create mode 100644 man/get_value_types.Rd
create mode 100644 man/guess_structure.Rd
create mode 100644 man/node_to_r2ogs6_obj.Rd
create mode 100644 man/order_parameters.Rd
create mode 100644 man/pick_vtu_file.Rd
create mode 100644 man/read_in.Rd
create mode 100644 man/read_in_curves.Rd
create mode 100644 man/read_in_gml.Rd
create mode 100644 man/read_in_linear_solvers.Rd
create mode 100644 man/read_in_media.Rd
create mode 100644 man/read_in_nonlinear_solvers.Rd
create mode 100644 man/read_in_parameters.Rd
create mode 100644 man/read_in_points.Rd
create mode 100644 man/read_in_polylines.Rd
create mode 100644 man/read_in_prj.Rd
create mode 100644 man/read_in_process_variables.Rd
create mode 100644 man/read_in_processes.Rd
create mode 100644 man/read_in_surfaces.Rd
create mode 100644 man/read_in_test_definition.Rd
create mode 100644 man/read_in_time_loop.Rd
create mode 100644 man/read_in_vtu.Rd
create mode 100644 man/strings_equal.Rd
create mode 100644 man/validate_read_in_xml.Rd
create mode 100644 man/vector_from_nodeset.Rd
diff --git a/man/check_file_extension.Rd b/man/check_file_extension.Rd
new file mode 100644
index 0000000..8199125
--- /dev/null
+++ b/man/check_file_extension.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_utils.R
+\name{check_file_extension}
+\alias{check_file_extension}
+\title{check_file_extension}
+\usage{
+check_file_extension(file, expected_extension)
+}
+\arguments{
+\item{file}{A file}
+
+\item{expected_extension}{The expected file extension}
+}
+\description{
+Helper function to check the extension of a file
+}
diff --git a/man/generate_as_node_func.Rd b/man/generate_as_node_func.Rd
new file mode 100644
index 0000000..13aff84
--- /dev/null
+++ b/man/generate_as_node_func.Rd
@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/generate_functions.R
+\name{generate_as_node_func}
+\alias{generate_as_node_func}
+\title{generate_as_node_func}
+\usage{
+generate_as_node_func(
+ file,
+ element_name,
+ subclasses = NULL,
+ show_result = TRUE
+)
+}
+\arguments{
+\item{file}{The XML file to parse}
+
+\item{element_name}{The name of the XML element to base the method on}
+
+\item{subclasses}{Optional: A named vector of subclasses}
+
+\item{show_result}{Should the generated function be printed to the console?}
+}
+\description{
+Generates a method for the generic function as_node based on an XML element
+}
diff --git a/man/generate_as_node_method_content.Rd b/man/generate_as_node_method_content.Rd
new file mode 100644
index 0000000..c10c787
--- /dev/null
+++ b/man/generate_as_node_method_content.Rd
@@ -0,0 +1,22 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/generate_functions.R
+\name{generate_as_node_method_content}
+\alias{generate_as_node_method_content}
+\title{generate_as_node_method_content}
+\usage{
+generate_as_node_method_content(
+ element,
+ iteration_depth = 0,
+ subclasses = NULL
+)
+}
+\arguments{
+\item{element}{The XML element to base the method on}
+
+\item{iteration_depth}{Utility parameter for the recursion, just leave this alone!}
+
+\item{subclasses}{Optional: A named vector of subclasses}
+}
+\description{
+...
+}
diff --git a/man/generate_simple_read_in.Rd b/man/generate_simple_read_in.Rd
new file mode 100644
index 0000000..13283e7
--- /dev/null
+++ b/man/generate_simple_read_in.Rd
@@ -0,0 +1,26 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/generate_functions.R
+\name{generate_simple_read_in}
+\alias{generate_simple_read_in}
+\title{generate_simple_read_in}
+\usage{
+generate_simple_read_in(
+ element_name,
+ child_name,
+ has_name_tag = TRUE,
+ subclasses_names = NULL
+)
+}
+\arguments{
+\item{element_name}{The name of the .prj element to be read from (wrapper element, e.g. 'processes')}
+
+\item{child_name}{The name of the element children (e.g. 'process')}
+
+\item{has_name_tag}{Do the child elements have a child element with the name 'name'?}
+
+\item{subclasses_names}{Optional: A character vector containing the names of r2ogs6_*
+subclasses (r2ogs6_* classes without a method for input_add)}
+}
+\description{
+Assuming function read_in gets good enough results, this could save code later.
+}
diff --git a/man/get_value_types.Rd b/man/get_value_types.Rd
new file mode 100644
index 0000000..7ffe582
--- /dev/null
+++ b/man/get_value_types.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{get_value_types}
+\alias{get_value_types}
+\title{get_value_types}
+\usage{
+get_value_types(xml_node)
+}
+\arguments{
+\item{xml_node}{An XML node (of class xml2::xml_node)}
+}
+\description{
+Gets the type of an XML value based on the documentation
+(per default, XML values are read in as a string, but for many elements,
+we want to coerce them to double)
+}
diff --git a/man/guess_structure.Rd b/man/guess_structure.Rd
new file mode 100644
index 0000000..227acea
--- /dev/null
+++ b/man/guess_structure.Rd
@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_utils.R
+\name{guess_structure}
+\alias{guess_structure}
+\title{guess_structure}
+\usage{
+guess_structure(xml_node, subclasses_names = NULL)
+}
+\arguments{
+\item{xml_node}{An XML node (of class xml2::xml_node)}
+
+\item{subclasses_names}{Optional: A character vector containing the names of r2ogs6_*
+subclasses (r2ogs6_* classes without a method for input_add)}
+}
+\description{
+Guesses the R representation of an XML node and adds it to parameter list
+ASSUMPTIONS:
+1) Leaf nodes will have EITHER a value OR attributes (and will not be missing both, e.g. '<a/>').
+2) Leaf nodes will never be r2ogs6_* objects
+3) If there are multiple occurrences of r2ogs6_* class (and subclass) elements on the same level,
+they have a wrapper node as their parent (e.g. <processes>, <properties>) which
+will contain ONLY elements of this type
+4) Wrapper nodes are represented as lists
+5) Parent nodes whose children have no children are represented as lists
+}
diff --git a/man/node_to_r2ogs6_obj.Rd b/man/node_to_r2ogs6_obj.Rd
new file mode 100644
index 0000000..0c15db5
--- /dev/null
+++ b/man/node_to_r2ogs6_obj.Rd
@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_utils.R
+\name{node_to_r2ogs6_obj}
+\alias{node_to_r2ogs6_obj}
+\title{node_to_r2ogs6_obj}
+\usage{
+node_to_r2ogs6_obj(xml_node, subclasses_names = NULL)
+}
+\arguments{
+\item{xml_node}{An XML node (of class xml2::xml_node)}
+
+\item{subclasses_names}{Optional: A character vector containing the names of r2ogs6_*
+subclasses (r2ogs6_* classes without a method for input_add)}
+}
+\description{
+Takes an XML node and turns it into a class object
+}
diff --git a/man/order_parameters.Rd b/man/order_parameters.Rd
new file mode 100644
index 0000000..254aeb7
--- /dev/null
+++ b/man/order_parameters.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_utils.R
+\name{order_parameters}
+\alias{order_parameters}
+\title{order_parameters}
+\usage{
+order_parameters(parameter_list, class_name)
+}
+\arguments{
+\item{parameter_list}{A list of parameters}
+
+\item{class_name}{The name of a class}
+}
+\description{
+Orders a list of parameters corresponding to the argument order of a class
+}
diff --git a/man/pick_vtu_file.Rd b/man/pick_vtu_file.Rd
new file mode 100644
index 0000000..1360afd
--- /dev/null
+++ b/man/pick_vtu_file.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_vtu.R
+\name{pick_vtu_file}
+\alias{pick_vtu_file}
+\title{pick_vtu_file}
+\usage{
+pick_vtu_file(ogs6_obj)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+}
+\description{
+Lets the user pick a .vtu file and adds it to the specified OGS6 class object
+}
diff --git a/man/read_in.Rd b/man/read_in.Rd
new file mode 100644
index 0000000..6b40163
--- /dev/null
+++ b/man/read_in.Rd
@@ -0,0 +1,34 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_utils.R
+\name{read_in}
+\alias{read_in}
+\title{read_in}
+\usage{
+read_in(
+ ogs6_obj,
+ prj_path,
+ element_name,
+ child_name,
+ selection_vector = NULL,
+ subclasses_names = NULL
+)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the elements should be read from}
+
+\item{element_name}{The name of the .prj element to be read from (wrapper element, e.g. 'processes')}
+
+\item{child_name}{The name of the child elements (e.g. 'process')}
+
+\item{selection_vector}{Optional: Either a character vector containing the names of the children
+OR a numeric vector containing their wanted indices}
+
+\item{subclasses_names}{Optional: A named character vector containing the names of r2ogs6_*
+subclasses (r2ogs6_* classes without a method for input_add)
+e.g. c(process = "r2ogs6_tl_process") if child_name would be time_loop}
+}
+\description{
+Reads in elements from a .prj file
+}
diff --git a/man/read_in_curves.Rd b/man/read_in_curves.Rd
new file mode 100644
index 0000000..29c7e6c
--- /dev/null
+++ b/man/read_in_curves.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_curves}
+\alias{read_in_curves}
+\title{read_in_curves}
+\usage{
+read_in_curves(ogs6_obj, prj_path, curve_names = NULL)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the curve elements should be read from}
+
+\item{curve_names}{Optional: The names of the curve elements to be read in}
+}
+\description{
+Reads in curve elements from a .prj file
+}
diff --git a/man/read_in_gml.Rd b/man/read_in_gml.Rd
new file mode 100644
index 0000000..afb696c
--- /dev/null
+++ b/man/read_in_gml.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_gml.R
+\name{read_in_gml}
+\alias{read_in_gml}
+\title{read_in_gml}
+\usage{
+read_in_gml(ogs6_obj, gml_path)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{gml_path}{The path to the geometry file that should be read in}
+}
+\description{
+Wrapper function to read in a whole .gml file
+}
diff --git a/man/read_in_linear_solvers.Rd b/man/read_in_linear_solvers.Rd
new file mode 100644
index 0000000..584247b
--- /dev/null
+++ b/man/read_in_linear_solvers.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_linear_solvers}
+\alias{read_in_linear_solvers}
+\title{read_in_linear_solvers}
+\usage{
+read_in_linear_solvers(ogs6_obj, prj_path, linear_solver_names = NULL)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the linear_solver elements should be read from}
+
+\item{linear_solver_names}{Optional: The names of the linear_solver elements to be read in}
+}
+\description{
+Reads in linear_solver elements from a .prj file
+}
diff --git a/man/read_in_media.Rd b/man/read_in_media.Rd
new file mode 100644
index 0000000..ee48fdc
--- /dev/null
+++ b/man/read_in_media.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_media}
+\alias{read_in_media}
+\title{read_in_media}
+\usage{
+read_in_media(ogs6_obj, prj_path, medium_indices = NULL)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the medium elements should be read from}
+
+\item{medium_indices}{Optional: The indices of the medium elements to be read in}
+}
+\description{
+Reads in medium elements from a .prj file
+}
diff --git a/man/read_in_nonlinear_solvers.Rd b/man/read_in_nonlinear_solvers.Rd
new file mode 100644
index 0000000..bbdfc1b
--- /dev/null
+++ b/man/read_in_nonlinear_solvers.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_nonlinear_solvers}
+\alias{read_in_nonlinear_solvers}
+\title{read_in_nonlinear_solvers}
+\usage{
+read_in_nonlinear_solvers(ogs6_obj, prj_path, nonlinear_solver_names = NULL)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the nonlinear_solver elements should be read from}
+
+\item{nonlinear_solver_names}{Optional: The names of the nonlinear_solver elements to be read in}
+}
+\description{
+Reads in nonlinear_solver elements from a .prj file
+}
diff --git a/man/read_in_parameters.Rd b/man/read_in_parameters.Rd
new file mode 100644
index 0000000..8fd76fa
--- /dev/null
+++ b/man/read_in_parameters.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_parameters}
+\alias{read_in_parameters}
+\title{read_in_parameters}
+\usage{
+read_in_parameters(ogs6_obj, prj_path, parameter_names = NULL)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the parameter elements should be read from}
+
+\item{parameter_names}{Optional: The names of the parameter elements to be read in}
+}
+\description{
+Reads in parameter elements from a .prj file
+}
diff --git a/man/read_in_points.Rd b/man/read_in_points.Rd
new file mode 100644
index 0000000..e0956b9
--- /dev/null
+++ b/man/read_in_points.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_gml.R
+\name{read_in_points}
+\alias{read_in_points}
+\title{read_in_points}
+\usage{
+read_in_points(xml_doc)
+}
+\arguments{
+\item{xml_doc}{A parsed XML document (of class 'xml2::xml_document')}
+}
+\description{
+Reads points from a .gml file
+}
diff --git a/man/read_in_polylines.Rd b/man/read_in_polylines.Rd
new file mode 100644
index 0000000..242ac2a
--- /dev/null
+++ b/man/read_in_polylines.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_gml.R
+\name{read_in_polylines}
+\alias{read_in_polylines}
+\title{read_in_polylines}
+\usage{
+read_in_polylines(xml_doc)
+}
+\arguments{
+\item{xml_doc}{A parsed XML document (of class 'xml2::xml_document')}
+}
+\description{
+Reads polylines from a .gml file
+}
diff --git a/man/read_in_prj.Rd b/man/read_in_prj.Rd
new file mode 100644
index 0000000..3bda7d9
--- /dev/null
+++ b/man/read_in_prj.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_prj}
+\alias{read_in_prj}
+\title{read_in_prj}
+\usage{
+read_in_prj(ogs6_obj, prj_path)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file that should be read in}
+}
+\description{
+Wrapper function to read in a whole .prj file
+}
diff --git a/man/read_in_process_variables.Rd b/man/read_in_process_variables.Rd
new file mode 100644
index 0000000..92c255e
--- /dev/null
+++ b/man/read_in_process_variables.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_process_variables}
+\alias{read_in_process_variables}
+\title{read_in_process_variables}
+\usage{
+read_in_process_variables(ogs6_obj, prj_path, process_variable_names = NULL)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the process_variable elements should be read from}
+
+\item{process_variable_names}{Optional: The names of the process_variable elements to be read in}
+}
+\description{
+Reads in process_variable elements from a .prj file
+}
diff --git a/man/read_in_processes.Rd b/man/read_in_processes.Rd
new file mode 100644
index 0000000..cbb060c
--- /dev/null
+++ b/man/read_in_processes.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_processes}
+\alias{read_in_processes}
+\title{read_in_processes}
+\usage{
+read_in_processes(ogs6_obj, prj_path, process_names = NULL)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the process elements should be read from}
+
+\item{process_names}{Optional: The names of the process elements to be read in}
+}
+\description{
+Reads in process elements from a .prj file
+}
diff --git a/man/read_in_surfaces.Rd b/man/read_in_surfaces.Rd
new file mode 100644
index 0000000..f197240
--- /dev/null
+++ b/man/read_in_surfaces.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_gml.R
+\name{read_in_surfaces}
+\alias{read_in_surfaces}
+\title{read_in_surfaces}
+\usage{
+read_in_surfaces(xml_doc)
+}
+\arguments{
+\item{xml_doc}{A parsed XML document (of class 'xml2::xml_document')}
+}
+\description{
+Reads surfaces from a .gml file
+}
diff --git a/man/read_in_test_definition.Rd b/man/read_in_test_definition.Rd
new file mode 100644
index 0000000..e0c538a
--- /dev/null
+++ b/man/read_in_test_definition.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_test_definition}
+\alias{read_in_test_definition}
+\title{read_in_test_definition}
+\usage{
+read_in_test_definition(ogs6_obj, prj_path, vtkdiff_indices = NULL)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the vtkdiff elements should be read from}
+
+\item{vtkdiff_indices}{Optional: The indices of the vtkdiff elements to be read in}
+}
+\description{
+Reads in vtkdiff elements from a .prj file
+}
diff --git a/man/read_in_time_loop.Rd b/man/read_in_time_loop.Rd
new file mode 100644
index 0000000..5f32542
--- /dev/null
+++ b/man/read_in_time_loop.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_prj.R
+\name{read_in_time_loop}
+\alias{read_in_time_loop}
+\title{read_in_time_loop}
+\usage{
+read_in_time_loop(ogs6_obj, prj_path)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{prj_path}{The path to the project file the time_loop element should be read from}
+}
+\description{
+Reads in time_loop element from a .prj file
+}
diff --git a/man/read_in_vtu.Rd b/man/read_in_vtu.Rd
new file mode 100644
index 0000000..7de06c7
--- /dev/null
+++ b/man/read_in_vtu.Rd
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_vtu.R
+\name{read_in_vtu}
+\alias{read_in_vtu}
+\title{read_in_vtu}
+\usage{
+read_in_vtu(ogs6_obj, vtu_path)
+}
+\arguments{
+\item{ogs6_obj}{A OGS6 class object}
+
+\item{vtu_path}{The path to the mesh file that should be read in}
+}
+\description{
+Wrapper function to read in a whole .vtu file
+}
diff --git a/man/strings_equal.Rd b/man/strings_equal.Rd
new file mode 100644
index 0000000..4043eb0
--- /dev/null
+++ b/man/strings_equal.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/generate_functions.R
+\name{strings_equal}
+\alias{strings_equal}
+\title{strings_equal}
+\usage{
+strings_equal(strings_vector)
+}
+\arguments{
+\item{strings_vector}{A vector or a list of strings}
+}
+\description{
+Checks if all strings in a vector or list are equal
+}
diff --git a/man/validate_read_in_xml.Rd b/man/validate_read_in_xml.Rd
new file mode 100644
index 0000000..cabc846
--- /dev/null
+++ b/man/validate_read_in_xml.Rd
@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_utils.R
+\name{validate_read_in_xml}
+\alias{validate_read_in_xml}
+\title{validate_read_in_xml}
+\usage{
+validate_read_in_xml(file)
+}
+\arguments{
+\item{file}{A file to be parsed as XML}
+}
+\value{
+The parsed XML file (as class object of type xml2::xml_document)
+}
+\description{
+Utility function, tries parsing the provided file as an XML document
+}
diff --git a/man/vector_from_nodeset.Rd b/man/vector_from_nodeset.Rd
new file mode 100644
index 0000000..0b54312
--- /dev/null
+++ b/man/vector_from_nodeset.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_in_utils.R
+\name{vector_from_nodeset}
+\alias{vector_from_nodeset}
+\title{vector_from_nodeset}
+\usage{
+vector_from_nodeset(xml_nodeset)
+}
+\arguments{
+\item{xml_nodeset}{An XML nodeset (of class xml2::xml_nodeset)}
+}
+\description{
+Creates a named vector from a nodeset
+}
--
GitLab