version 1.0 release on CRAN!

mkoohafkan · Oct 11, 2015 · 7b8a63e · 7b8a63e
1 parent cf8fe53
commit 7b8a63e
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 6 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,11 +1,11 @@
 Package: rivr
 Type: Package
 Title: Steady and Unsteady Open-Channel Flow Computation
-Version: 1.0
-Date: 2015-10-06
+Version: 1.0.0.9000
+Date: 2015-10-11
 Author: Michael C Koohafkan [aut, cre]
 Maintainer: Michael C Koohafkan <michael.koohafkan@gmail.com>
-Description: A tool for undergraduate courses in open-channel hydraulics.
+Description: A tool for undergraduate and graduate courses in open-channel hydraulics.
     Provides functions for computing normal and critical depths, steady-state
     water surface profiles (e.g. backwater curves) and unsteady flow
     computations (e.g. flood wave routing).

diff --git a/NAMESPACE b/NAMESPACE
@@ -19,4 +19,5 @@ importFrom(graphics,plot)
 importFrom(utils,head)
 importFrom(utils,str)
 importFrom(utils,tail)
+importFrom(utils,stack)
 useDynLib(rivr)
diff --git a/README.md b/README.md
@@ -4,11 +4,20 @@ rivr: An R package for Open Channel Hydraulics
 [![Build Status](https://travis-ci.org/mkoohafkan/rivr.svg)](https://travis-ci.org/mkoohafkan/rivr)
 
 This package is designed as an educational tool for students and instructors 
-of undergraduate courses in open channel hydraulics. Functions are provided 
-for computing flow and channel geometry, normal and critical depths, 
+of undergraduate and graduate courses in open channel hydraulics. Functions are 
+provided for computing flow and channel geometry, normal and critical depth, 
 gradually-varied water-surface profiles (e.g. backwater curves) and unsteady 
 flow (e.g. flood wave routing).
 
+UPDATE 10/11/2015
+---------------
+
+Version 1.0 now on CRAN! This major version update defines an S3 class for 
+`rivr` and methods for printing, summarizing and plotting results of 
+gradually-varied and unsteady flow simulations. A technical vignette has also
+been added that provides nitty-gritty details on the derivations and numerical
+schemes used in the package.
+
 UPDATE 4/2/2015
 ---------------
 

diff --git a/vignettes/quickstart.Rmd b/vignettes/quickstart.Rmd
@@ -22,7 +22,7 @@ Class methods
 -------------
 
 The `rivr` package defines a new class `rivr`, which is essentially an 
-extension of the `data.frame` class with additional atributes. The
+extension of the `data.frame` class with additional atributes. The following
 methods are defined for class `rivr`:
 
   - `head` 
@@ -31,6 +31,8 @@ methods are defined for class `rivr`:
   - `summary`
   - `plot`
 
+
+
 Computing normal and critical depth
 -----------------------------------