update README, DESCRIPTION, NEWS

- updates to describe urbanVPRM implementation

DESCRIPTION

@@ -1,19 +1,19 @@
 Package: VPRMLandSfcModel
 Type: Package
 Title: R implementation of VPRM with parameter estimation
-Version: 1.2.1
-Date: 2017-10-03
+Version: 1.3.0
+Date: 2023-07-07
 Author: Timothy W. Hilton
-Maintainer: Timothy W. Hilton <[email protected]>
+Maintainer: Timothy W. Hilton <[email protected]>
 Description: Provides an R implementation of the Vegetation
-    Photosynthesis and Respiration Model (VPRM) and tools to estimate
-    VPRM parameter values from observations.  VPRM is a simple
-    diagnostic land surface model based on light-use efficiency.  VPRM
-    diagnoses gross ecosystem exchange (GEE) of carbon dioxide,
-    ecosystem respiration (R), and net ecosystem exchange (NEE) of
-    carbon dioxide. To cite the VPRMLandSfcModel R package or the VPRM
-    model itself in a publication, or for a more detailed description
-    of VPRM, see (within R) 'citation("VPRMLandSurfaceModel")'.
+    Photosynthesis and Respiration Model (VPRM), the urbanVPRM, and tools to
+    estimate VPRM parameter values from observations. VPRM is a simple
+    diagnostic land surface model based on light-use efficiency. VPRM diagnoses
+    gross ecosystem exchange (GEE) of carbon dioxide, ecosystem respiration (R),
+    and net ecosystem exchange (NEE) of carbon dioxide. To cite the
+    VPRMLandSfcModel R package or the (urban)VPRM model itself in a publication, or for
+    a more detailed description of VPRM, see (within R)
+    'citation("VPRMLandSurfaceModel")'.
 License: GPL-3
 LazyLoad: yes
 Imports:
@@ -24,5 +24,5 @@ Suggests:
     knitr,
     rmarkdown
 VignetteBuilder: knitr
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
 Encoding: UTF-8

NEWS

@@ -1,3 +1,6 @@
+New features in version 1.3.0
+- implement the urbanVPRM adaptation of VPRM to urban settings
+
 New features in version 1.2.1
 - added vignette to provide usage examples
 
@@ -15,4 +18,4 @@ New features in version 1.1
 - added Park_Falls dataset
 - added example code for all functions
 - changed package name from VPRMModel to VPRMLandSfcModel.  See
-  ChangeLog for reasoning.
+  ChangeLog for reasoning.

README.md

@@ -2,23 +2,23 @@
 
 # Description:
 
-Provides an R implementation of the Vegetation Photosynthesis and
-Respiration Model (VPRM) of Mahadevan et al (2008) and tools to
-estimate VPRM parameter values from observations.  VPRM is a
-simple diagnostic land surface model based on light-use
-efficiency.  VPRM diagnoses gross ecosystem exchange (GEE) of
-carbon dioxide, ecosystem respiration (R), and net ecosystem
-exchange (NEE) of carbon dioxide.  VPRM parameters may be
-estimated separately for different subsets of a dataset of
-observations.  If the Rmpi package is installed, such separate
-parameter estimations may be run in parallel.
+Provides an R implementation of the Vegetation Photosynthesis and Respiration
+Model (VPRM) of Mahadevan et al (2008), the urbanVPRM of Hardiman et al (2017),
+and tools to estimate VPRM parameter values from observations. VPRM is a simple
+diagnostic land surface model based on light-use efficiency. VPRM diagnoses
+gross ecosystem exchange (GEE) of carbon dioxide, ecosystem respiration (R), and
+net ecosystem exchange (NEE) of carbon dioxide. The urbanVPRM adapts the VPRM to
+urban settings by adjusting GEE and R to account for impervious surface area and
+the urban heat island effect. (urban)VPRM parameters may be estimated separately
+for different subsets of a dataset of observations. If the Rmpi package is
+installed, such separate parameter estimations may be run in parallel.
 
 # Details:
 
 - Package:   VPRMLandSfcModel
 - Type:      Package
-- Version:   1.2.1
-- Date:      2017-10-03
+- Version:   1.3.0
+- Date:      2023-07-07
 - License:   GPL-3
 - LazyLoad:  yes
 
@@ -81,6 +81,12 @@ itself, use:
 > model (VPRM). Global Biogeochemical Cycles, 22, GB2005.
 > doi:10.1029/2006GB002735.
 
+To cite the urban Vegetation Photosynthesis Respiration Model (urbanVPRM) use
+> Hardiman, B. S., Wang, J. A., Hutyra, L. R., Gately, C. K., Getson, J. M., &
+> Friedl, M. A. (2017). Accounting for urban biogenic fluxes in regional carbon
+> budgets. Science of The Total Environment, 592, 366–372.
+> https://doi.org/https://doi.org/10.1016/j.scitotenv.2017.03.028
+
 To cite the R package 'VPRMLandSfcModel', use:
 > Hilton, T. W., Davis, K. J., Keller, K., and Urban, N. M.:
 > Improving North American terrestrial CO2 flux diagnosis using