22output : github_document
33---
44
5+ <!-- README.md was generated from README.Rmd. Please edit that file -->
56
67``` {r setup, include=FALSE}
78knitr::opts_chunk$set(echo = TRUE)
@@ -17,6 +18,7 @@ RHESSysPreprocessing is a set of functions to produce the required inputs for RH
1718You can install RHESSysPreprocessing directly from R
1819
1920``` {r, eval = FALSE}
21+ # install.packages("devtools")
2022devtools::install_github("RHESSys/RHESSysPreprocessing")
2123```
2224
@@ -35,20 +37,20 @@ RHESSysPreprocessing contains a few main components:
3537<!-- * world_gen.R: Creates a worldfile for use in RHESSys (replaces g2w) -->
3638<!-- * CreateFlownet.R: Creates a RHESSys flowtable (replaces cf) -->
3739
38- | | |
39- | ---------------------| -----------------------------------------------------------------------|
40- | RHESSysPreprocess.R | An all-in-one function that runs both world_gen.R and CreateFlownet.R |
41- | world_gen.R | Creates a worldfile for use in RHESSys (replaces g2w) |
42- | CreateFlownet.R | Creates a RHESSys flowtable (replaces cf) |
40+ | | |
41+ | ----------------------- | ---- -----------------------------------------------------------------------|
42+ | ` RHESSysPreprocess() ` | An all-in-one function that runs both ` world_gen() ` and ` CreateFlownet() ` |
43+ | ` world_gen() ` | Creates a worldfile for use in RHESSys (replaces g2w) |
44+ | ` CreateFlownet() ` | Creates a RHESSys flowtable (replaces cf) |
4345
4446Other functions of note that can be used on their own:
4547
46- | | |
47- | ---------------------| -----------------------------------------------------------------------|
48- | template_read.R | Reads a template file and produces an R list |
49- | build_meta.R | Builds a metadata file. <under construction |
50- | convert_flowtable.R | Converts a non-parallelized (RHESSys < 7.0) flowtable to a parallelized flowtable |
51- | read_in_flow.R | Reads a flow table and creates an R list. |
48+ | | |
49+ | ---------------------- | -----------------------------------------------------------------------|
50+ | ` template_read() ` | Reads a template file and produces an R list |
51+ | ` build_meta() ` | Builds a metadata file. <under construction |
52+ | ` convert_flowtable() ` | Converts a non-parallelized (RHESSys < 7.0) flowtable to a parallelized flowtable |
53+ | ` read_in_flow() ` | Reads a flow table and creates an R list. |
5254
5355## Compatibility
5456Developed originally using R Version 3.4.0. May be incompatible with older R versions
0 commit comments