[CRAN] Fix CRAN checks

hongyuanjia · Nov 17, 2021 · ff7a6b8 · ff7a6b8
1 parent 578d009
commit ff7a6b8
Show file tree

Hide file tree

Showing 38 changed files with 151 additions and 124 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,12 +1,12 @@
 Package: eplusr
 Title: A Toolkit for Using Whole Building Simulation Program
     'EnergyPlus'
-Version: 0.14.2.9018
+Version: 0.15.0
 Authors@R: c(
     person(given = "Hongyuan",
            family = "Jia",
            role = c("aut", "cre"),
-           email = "hongyuanjia@outlook.com",
+           email = "hongyuanjia@cqust.edu.cn",
            comment = c(ORCID = "0000-0002-0075-8183")),
     person(given = "Adrian",
            family = "Chong",

diff --git a/NEWS.md b/NEWS.md
@@ -3,7 +3,7 @@
 ## New features
 
 * `Idd$path()` is added to show the path of IDD parsed (#442).
-* Add epw data sources from [climate.onebuilding.org](http://climate.onebuilding.org/)
+* Add epw data sources from [climate.onebuilding.org](https://climate.onebuilding.org/)
   for `download_weather()`. `type` will always be `"all"` for those sources (#453).
 * Add a new `"stat"` option in `type` in `download_weather()` (#453).
 * `Idf$is_valid_id()` and `Idf$is_valid_name()` gain a new argument named

diff --git a/R/constants.R b/R/constants.R
@@ -140,7 +140,7 @@ utils::globalVariables(c(
     "area", "dt", "interval_type", "new_rleid", "time_index", "i.time_index",
     "i.environment_name", "i.environment_type", "i.simulation_index", "i.new",
     "value_lower_start", "expand_obj", "i.year", "provider", "energyplus_exe",
-    "exist", "resources", "ver", "Name"
+    "exist", "resources", "ver", "Name", "param_index"
 ))
 # }}}
 # nocov end
diff --git a/R/epw.R b/R/epw.R
@@ -2035,8 +2035,8 @@ format.Epw <- function (x, ...) {
 #'
 #' There are 2 data sources:
 #'
-#' * [EnergyPlus.net](https://energyplus.net/weather)
-#' * [OneBuilding.org](http://climate.onebuilding.org/)
+#' * [EnergyPlus.net](https://energyplus.net/)
+#' * [OneBuilding.org](https://climate.onebuilding.org/)
 #'
 #' EnergyPlus sources allow downloading EPW, STAT, and DDY files separately
 #' while OneBuilding sources can only download them all through a ZIP file.

diff --git a/R/geom.R b/R/geom.R
@@ -310,7 +310,7 @@ IdfGeometry <- R6Class("IdfGeometry", cloneable = FALSE,
         #' @details
         #' `$view()` uses the [rgl](https://cran.r-project.org/package=rgl)
         #' package to visualize the IDF geometry in 3D in a similar way as
-        #' [OpenStudio](https://www.openstudio.net).
+        #' [OpenStudio](https://openstudio.net/).
         #'
         #' `$view()` returns an [IdfViewer] object which can be used to further
         #' tweak the viewer scene.

diff --git a/R/idf.R b/R/idf.R
@@ -2568,7 +2568,7 @@ Idf <- R6::R6Class(classname = "Idf",
         #' @details
         #' `$view()` uses the [rgl](https://cran.r-project.org/package=rgl)
         #' package to visualize the IDF geometry in 3D in a similar way as
-        #' [OpenStudio](https://www.openstudio.net).
+        #' [OpenStudio](https://openstudio.net/).
         #'
         #' `$view()` returns an [IdfViewer] object which can be used to further
         #' tweak the viewer scene.

diff --git a/R/param.R b/R/param.R
@@ -164,7 +164,10 @@ ParametricJob <- R6::R6Class(classname = "ParametricJob", cloneable = FALSE,
         #' ```
         #' param$param(
         #'     `Supply Fan 1` = list(Fan_Total_Efficiency = seq(0.1, 1.0, 0.1)),
-        #'     Material := list(Thickness = seq(0.01, 0.1, 0.1), Conductivity = seq(0.1, 1.0, 0.1))
+        #'     Material := list(
+        #'         Thickness = seq(0.01, 0.1, 0.1),
+        #'         Conductivity = seq(0.1, 1.0, 0.1)
+        #'     )
         #' )
         #' ```
         #'
@@ -185,13 +188,19 @@ ParametricJob <- R6::R6Class(classname = "ParametricJob", cloneable = FALSE,
         #' \dontrun{
         #'
         #' param$param(
-        #'     Material := list(Thickness = seq(0.1, 1, length.out = 3), Conductivity = seq(0.1, 0.6, length.out = 3)),
-        #'     "Supply Fan 1" = list(fan_total_efficiency = c(0.1, 0.5, 0.8))
+        #'     Material := .(
+        #'         Thickness = seq(0.1, 1, length.out = 3),
+        #'         Conductivity = seq(0.1, 0.6, length.out = 3)
+        #'     ),
+        #'    "Supply Fan 1" = .(fan_total_efficiency = c(0.1, 0.5, 0.8))
         #' )
         #'
         #' # specify parameter values
         #' param$param(
-        #'     Material := list(Thickness = seq(0.1, 1, length.out = 3), Conductivity = seq(0.1, 0.6, length.out = 3)),
+        #'     Material := .(
+        #'         Thickness = seq(0.1, 1, length.out = 3),
+        #'         Conductivity = seq(0.1, 0.6, length.out = 3)
+        #'      ),
         #'     "Supply Fan 1" = list(fan_total_efficiency = c(0.1, 0.5, 0.8)),
         #'     .names = c("thickness", "conduct", "fan_eff")
         #' )
@@ -206,7 +215,10 @@ ParametricJob <- R6::R6Class(classname = "ParametricJob", cloneable = FALSE,
         #'
         #' # use all combinations of parameters
         #' param$param(
-        #'     Material := list(Thickness = seq(0.1, 1, length.out = 3), Conductivity = seq(0.1, 0.6, length.out = 3)),
+        #'     Material := list(
+        #'         Thickness = seq(0.1, 1, length.out = 3),
+        #'         Conductivity = seq(0.1, 0.6, length.out = 3)
+        #'     ),
         #'     "Supply Fan 1" = list(fan_total_efficiency = c(0.1, 0.5, 0.8)),
         #'     .cross = TRUE
         #' )

diff --git a/README.Rmd b/README.Rmd
@@ -39,7 +39,7 @@ invisible(Sys.setlocale(category = "LC_TIME", locale = "en_US.UTF-8"))
 
 <!-- badges: start -->
 [![R build status](https://github.com/hongyuanjia/eplusr/workflows/R-CMD-check/badge.svg)](https://github.com/hongyuanjia/eplusr/actions)
-[![codecov](https://codecov.io/gh/hongyuanjia/eplusr/branch/master/graph/badge.svg?token=HoBA0Qm6k2)](https://codecov.io/gh/hongyuanjia/eplusr)
+[![codecov](https://codecov.io/gh/hongyuanjia/eplusr/branch/master/graph/badge.svg?token=HoBA0Qm6k2)](https://app.codecov.io/gh/hongyuanjia/eplusr)
 [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/eplusr)](https://cran.r-project.org/package=eplusr)
 [![CRAN Checks](https://cranchecks.info/badges/summary/eplusr)](https://cranchecks.info/pkgs/eplusr)
 [![CRAN Download Badge](https://cranlogs.r-pkg.org/badges/eplusr)](https://cran.r-project.org/package=eplusr)
@@ -188,9 +188,9 @@ Please see these vignettes and articles about {eplusr}
 I would like to thank many open source projects who have heavily inspired the
 development of eplusr package, especially these below:
 
-* [EnergyPlus](https://www.energyplus.net): A whole building energy simulation
+* [EnergyPlus](https://energyplus.net): A whole building energy simulation
   program.
-* [OpenStudio](https://www.openstudio.net): A cross-platform collection of
+* [OpenStudio](https://openstudio.net): A cross-platform collection of
   software tools to support whole building energy modeling using EnergyPlus and
   advanced daylight analysis using Radiance.
 * [eppy](https://github.com/santoshphilip/eppy): Scripting language for E+,

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 [![R build
 status](https://github.com/hongyuanjia/eplusr/workflows/R-CMD-check/badge.svg)](https://github.com/hongyuanjia/eplusr/actions)
-[![codecov](https://codecov.io/gh/hongyuanjia/eplusr/branch/master/graph/badge.svg?token=HoBA0Qm6k2)](https://codecov.io/gh/hongyuanjia/eplusr)
+[![codecov](https://codecov.io/gh/hongyuanjia/eplusr/branch/master/graph/badge.svg?token=HoBA0Qm6k2)](https://app.codecov.io/gh/hongyuanjia/eplusr)
 [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/eplusr)](https://cran.r-project.org/package=eplusr)
 [![CRAN
 Checks](https://cranchecks.info/badges/summary/eplusr)](https://cranchecks.info/pkgs/eplusr)
@@ -91,29 +91,29 @@ in interactive mode.
 
 ## Features
 
-  - Download, install EnergyPlus in R
-  - Read, parse and modify EnergyPlus:
-      - Input Data File (IDF)
-      - Weather File (EPW)
-      - Report Data Dictionary (RDD) & Meter Data Dictionary (MDD)
-      - Error File (ERR)
-  - Modify multiple versions of IDFs and run corresponding EnergyPlus
+-   Download, install EnergyPlus in R
+-   Read, parse and modify EnergyPlus:
+    -   Input Data File (IDF)
+    -   Weather File (EPW)
+    -   Report Data Dictionary (RDD) & Meter Data Dictionary (MDD)
+    -   Error File (ERR)
+-   Modify multiple versions of IDFs and run corresponding EnergyPlus
     both in the background and in the front
-  - Rich-featured interfaces to query and modify IDFs
-  - Automatically handle referenced fields and validate input during
+-   Rich-featured interfaces to query and modify IDFs
+-   Automatically handle referenced fields and validate input during
     modification
-  - Take fully advantage of most common used data structure for data
+-   Take fully advantage of most common used data structure for data
     science in R – data.frame
-      - Extract model, weather data into data.frames
-      - Modify multiple objects via data.frames input
-      - Query output via SQL in Tidy format which is much better for
+    -   Extract model, weather data into data.frames
+    -   Modify multiple objects via data.frames input
+    -   Query output via SQL in Tidy format which is much better for
         data analysis and visualization
-  - Provide a simple yet extensible prototype of conducting parametric
+-   Provide a simple yet extensible prototype of conducting parametric
     simulations and collect all results in one go
-  - A pure R-based version updater which is more than
+-   A pure R-based version updater which is more than
     [20X](https://hongyuanjia.github.io/eplusr/articles/transition.html)
     faster than VersionUpdater distributed with EnergyPlus
-  - Fast 3D geometry visualization
+-   Fast 3D geometry visualization
 
 **View IDF geometry in 3D**  
 <img src="https://github.com/hongyuanjia/eplusr/blob/master/tools/figures/view_geometry.gif?raw=true" width="60%" />
@@ -132,45 +132,45 @@ analysis**
 
 ### Articles
 
-  - Hongyuan Jia, Adrian Chong (2020). eplusr: A framework for
+-   Hongyuan Jia, Adrian Chong (2020). eplusr: A framework for
     integrating building energy simulation and data-driven analytics.
     doi: 10.13140/RG.2.2.34326.16966
-      - [Source code and data to reproduce figures in the
+    -   [Source code and data to reproduce figures in the
         article](https://github.com/ideas-lab-nus/eplusr-paper)
 
 ### Vignettes
 
 Please see these vignettes and articles about {eplusr}
 
-  - [Introduction to
+-   [Introduction to
     eplusr](https://hongyuanjia.github.io/eplusr/articles/eplusr.html)
-  - [Run simulation and data
+-   [Run simulation and data
     exploration](https://hongyuanjia.github.io/eplusr/articles/job.html)
-  - [Parametric
+-   [Parametric
     simulations](https://hongyuanjia.github.io/eplusr/articles/param.html)
-  - [Update IDF
+-   [Update IDF
     version](https://hongyuanjia.github.io/eplusr/articles/transition.html)
-  - [Work with weather
+-   [Work with weather
     files](https://hongyuanjia.github.io/eplusr/articles/epw.html)
-  - [Work with `Schedule:Compact`
+-   [Work with `Schedule:Compact`
     objects](https://hongyuanjia.github.io/eplusr/articles/schedule.html)
-  - [Work with
+-   [Work with
     geometries](https://hongyuanjia.github.io/eplusr/articles/geom.html)
-  - [Frequently asked
+-   [Frequently asked
     questions](https://hongyuanjia.github.io/eplusr/articles/faq.html)
 
 ### Slides
 
-  - [Slides: Interfacing EnergyPlus using
+-   [Slides: Interfacing EnergyPlus using
     R](https://hongyuanjia.github.io/eplusrIntro/)
 
 ## Additional resources
 
-  - eplusr manual: <https://hongyuanjia.github.io/eplusr/>
-  - eplusr Docker image: <https://github.com/hongyuanjia/eplusr-docker>
-  - [epwshiftr](https://CRAN.R-project.org/package=epwshiftr) for
+-   eplusr manual: <https://hongyuanjia.github.io/eplusr/>
+-   eplusr Docker image: <https://github.com/hongyuanjia/eplusr-docker>
+-   [epwshiftr](https://CRAN.R-project.org/package=epwshiftr) for
     creating future EnergyPlus weather files using CMIP6 data
-  - [epluspar](https://github.com/hongyuanjia/epluspar) for conducting
+-   [epluspar](https://github.com/hongyuanjia/epluspar) for conducting
     parametric analysis on EnergyPlus models, including sensitivity
     analysis, Bayesian calibration and optimization.
 
@@ -179,15 +179,15 @@ Please see these vignettes and articles about {eplusr}
 I would like to thank many open source projects who have heavily
 inspired the development of eplusr package, especially these below:
 
-  - [EnergyPlus](https://www.energyplus.net): A whole building energy
+-   [EnergyPlus](https://energyplus.net): A whole building energy
     simulation program.
-  - [OpenStudio](https://www.openstudio.net): A cross-platform
+-   [OpenStudio](https://openstudio.net): A cross-platform
     collection of software tools to support whole building energy
     modeling using EnergyPlus and advanced daylight analysis using
     Radiance.
-  - [eppy](https://github.com/santoshphilip/eppy): Scripting language
+-   [eppy](https://github.com/santoshphilip/eppy): Scripting language
     for E+, EnergyPlus.
-  - [JEplus](http://www.jeplus.org): An EnergyPlus simulation manager
+-   [JEplus](http://www.jeplus.org): An EnergyPlus simulation manager
     for parametrics.
 
 ## Author
@@ -200,7 +200,7 @@ The project is released under the terms of MIT License.
 
 Copyright © 2016-2021 Hongyuan Jia and Adrian Chong
 
------
+------------------------------------------------------------------------
 
 Please note that the ‘eplusr’ project is released with a [Contributor
 Code of

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,9 +1,9 @@
-# Version 0.14.2
+# Version 0.15.0
 
 ## Initial submission
 
-Change the maintainer email from 'hoongyuan.jia@bears-berkeley.sg' to
-'hongyuanjia@outlook.com'.
+Change the maintainer email from 'hongyuanjia@outlook.com' to
+'hongyuanjia@cqust.edu.cn'.
 
 ### Test environments
 
@@ -13,7 +13,16 @@ Change the maintainer email from 'hoongyuan.jia@bears-berkeley.sg' to
 
 ### R CMD check results
 
-0 errors | 0 warnings | 0 notes
+0 errors | 0 warnings | 1 note
+
+There is one note saying that the maintainer email address has been changed
+
+```
+   New maintainer:
+     Hongyuan Jia <hongyuanjia@cqust.edu.cn>
+   Old maintainer(s):
+     Hongyuan Jia <hongyuanjia@outlook.com>
+```
 
 ### Reverse dependencies
 

diff --git a/man/Idf.Rd b/man/Idf.Rd
diff --git a/man/IdfGeometry.Rd b/man/IdfGeometry.Rd