updating documentation

Author: dkopp3

StreamNetworkTools.docx

@@ -1,3 +1,4 @@
 .Rproj.user
 .Rhistory
 .RData
+inst/doc

StreamNetworkTools/.gitignore

@@ -1,9 +1,8 @@
 Package: StreamNetworkTools
 Title: Chracterizing Topology and Planform Geometry of NHDPlusV2 Stream Networks 
-Version: 0.0.0.9000
+Version: 1.0.0.000
 Authors@R: person("Darin", "Kopp", email = "darinkopp@gmail.com", role = c("aut", "cre"))
-Description: Chracterizing Topology and Planform Geometry of NHDPlusV2 Stream 	Networks is initiated by a set of user defined sampling points or a 		random sample of stream reaches of a specified order. From the sites, 	all upstream tributaries are identified and assembled into indvidual 			networks.  All subsequent functions are excuted with these networks as 	inputs and are categorized into Network-Scale Topology, Path-Scale         	Position (Currently Unavailable), Reach-Scale Planform Geometry and     
-   	NHDPlusV2 Value-Added Attribute and StreamCat Attribute (Currently 		Unavailable) Queries. Catchments associated with each reach can also be 	identified and be used 	to allocate other potential covariates of 		interest at different scales.
+Description: An R package to derive covariates from the NHDPlusV2 dataset and faciliate continental scale analyses of river networks.
 Depends: R (>= 3.4.2)
 License: Ask Mike
 Encoding: UTF-8
@@ -13,5 +12,9 @@ Imports: foreign,
     sp,
     rgdal,
     rgeos,
-    dplyr
+    dplyr,
+    reshape2
 RoxygenNote: 6.1.0
+Suggests: knitr,
+    rmarkdown
+VignetteBuilder: knitr

StreamNetworkTools/DESCRIPTION

@@ -0,0 +1,26 @@
+# example workflow for StreamNetworkTools
+remove.packages("StreamNetworkTools")
+
+# install devtools if not already
+#install.packages(devtools)
+library("devtools")
+#install StreamNetworkTools from github repository
+#install_git("https://github.com/dkopp3/StreamNetworkTools_git.git", subdir = "StreamNetworkTools")
+library(StreamNetworkTools)
+
+#check package help
+help(package="StreamNetworkTools")
+
+# to begin download NHDPlusV2 data for Vector Processing Unit (VPU) of interest
+# here we are using VPU 11 which includes Arkansas, Red and White River basins
+# check function documentation for further details
+# setwd to example folder - where NHDPlusV2 data will be downloaded
+# this is mostly to keep myself organized
+setwd("C:/Users/Darin/Dropbox/Dissertation/Chapter_2_StreamNetworkTools/StreamNetworkTools_git/Example_Data")
+
+?net_nhdplus
+net_nhdplus(nhdplus_path = getwd(), download = "http",
+            vpu = 11, files = ALL, zip_7 = "C:/Program Files/7-Zip")
+
+
+

StreamNetworkTools/vignettes/SNT_Examples.R

@@ -0,0 +1,28 @@
+---
+title: "StreamNetworkTools Vignette"
+author: "Darin Kopp"
+date: "`r Sys.Date()`"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{StreamNetworkTools Vignette}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r setup, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+This vignette discusses the useage of StreamNetworkTools, an R package to derive covariates from NHDPlusV2 dataset and faciliate large (continental) scale analyses of river networks. 
+
+Installing StreamNetworkTools*
+1)	library("devtools")
+install_git("https://github.com/dkopp3/StreamNetworkTools_git.git", subdir = "StreamNetworkTools")
+2)	install_github(“dkopp3/StreamNetworkTools_git”, subdir = "StreamNetworkTools")
+
+
+
+