From ef5a3640653d33b40e7d341d9261eea26a651efa Mon Sep 17 00:00:00 2001 From: aheinri5 <Anna@netzkritzler.de> Date: Fri, 25 Dec 2020 21:17:26 +0100 Subject: [PATCH] [base] NAMESPACE, DESCRIPTION and doc cleanup --- .gitignore | 1 - DESCRIPTION | 5 ++++- NAMESPACE | 57 ----------------------------------------------------- man/OGS6.Rd | 11 +++++++++-- 4 files changed, 13 insertions(+), 61 deletions(-) delete mode 100644 NAMESPACE diff --git a/.gitignore b/.gitignore index c828c93..01306d4 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,4 @@ .RData .Ruserdata packrat/lib*/ -packrat/src/ inst/doc diff --git a/DESCRIPTION b/DESCRIPTION index f407eb9..87faf07 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -37,6 +37,9 @@ Imports: curl, xtable, dplyr, - rlang + rlang, + doParallel RoxygenNote: 7.1.1 VignetteBuilder: knitr +Depends: + foreach diff --git a/NAMESPACE b/NAMESPACE deleted file mode 100644 index fc47916..0000000 --- a/NAMESPACE +++ /dev/null @@ -1,57 +0,0 @@ -# Generated by roxygen2: do not edit by hand - -export(OGS6) -export(OGS6_Chain) -export(OGS6_Ensemble) -export(OGS6_UnstructuredGrid) -export(OGS6_mesh) -export(generate_benchmark_script) -export(generate_structured_mesh) -export(pick_vtu_file) -export(r2ogs6_borehole_heat_exchanger) -export(r2ogs6_boundary_condition) -export(r2ogs6_capillary_pressure) -export(r2ogs6_chemical_system) -export(r2ogs6_com_property) -export(r2ogs6_component) -export(r2ogs6_convergence_criterion) -export(r2ogs6_curve) -export(r2ogs6_deactivated_subdomain) -export(r2ogs6_eigen) -export(r2ogs6_flow_and_temperature_control) -export(r2ogs6_fluid) -export(r2ogs6_fracture_model) -export(r2ogs6_fracture_properties) -export(r2ogs6_global_process_coupling) -export(r2ogs6_gml) -export(r2ogs6_insitu) -export(r2ogs6_jacobian_assembler) -export(r2ogs6_kinetic_reactant) -export(r2ogs6_linear_solver) -export(r2ogs6_local_coordinate_system) -export(r2ogs6_material_property) -export(r2ogs6_medium) -export(r2ogs6_nonlinear_solver) -export(r2ogs6_output) -export(r2ogs6_parameter) -export(r2ogs6_ph_property) -export(r2ogs6_phase) -export(r2ogs6_phase_component) -export(r2ogs6_phasefield_parameters) -export(r2ogs6_pipes) -export(r2ogs6_porous_medium) -export(r2ogs6_pr_property) -export(r2ogs6_process) -export(r2ogs6_process_variable) -export(r2ogs6_rate) -export(r2ogs6_search_length_algorithm) -export(r2ogs6_solution) -export(r2ogs6_source_term) -export(r2ogs6_time_loop) -export(r2ogs6_time_stepping) -export(r2ogs6_tl_process) -export(r2ogs6_vtkdiff) -export(read_in_gml) -export(read_in_prj) -export(read_in_vtu) -export(run_simulation) diff --git a/man/OGS6.Rd b/man/OGS6.Rd index f99e587..58f618b 100644 --- a/man/OGS6.Rd +++ b/man/OGS6.Rd @@ -346,11 +346,18 @@ Adds a r2ogs6_insitu object \subsection{Method \code{get_status()}}{ Checks if the OGS6 object has all necessary parameters for starting a simulation -print_log \subsection{Usage}{ -\if{html}{\out{<div class="r">}}\preformatted{OGS6$get_status()}\if{html}{\out{</div>}} +\if{html}{\out{<div class="r">}}\preformatted{OGS6$get_status(print_status = TRUE)}\if{html}{\out{</div>}} } +\subsection{Arguments}{ +\if{html}{\out{<div class="arguments">}} +\describe{ +\item{\code{print_status}}{flag: Should the status be printed to the console? +print_log} +} +\if{html}{\out{</div>}} +} } \if{html}{\out{<hr>}} \if{html}{\out{<a id="method-print_log"></a>}} -- GitLab