Skip to content

Commit

Permalink
v0.14.0 RC
Browse files Browse the repository at this point in the history
Increment version number
[CRAN] Check revdep
[CRAN] Update CRAN comments
[docs] Fix typos
  • Loading branch information
Hongyuan Jia committed Dec 19, 2020
1 parent 06aff03 commit 53ecf2b
Show file tree
Hide file tree
Showing 25 changed files with 75 additions and 147 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: eplusr
Title: A Toolkit for Using Whole Building Simulation Program
'EnergyPlus'
Version: 0.13.0.9000
Version: 0.14.0
Authors@R:
person(given = "Hongyuan",
family = "Jia",
Expand Down
16 changes: 8 additions & 8 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# eplusr (development version)
# eplusr 0.14.0

## New features

Expand Down Expand Up @@ -28,7 +28,7 @@

## Minor changes

* Now rgl and decido package has beem moved from *Imports* to *Suggests*, since
* Now rgl and decido package has been moved from *Imports* to *Suggests*, since
they are only used in the `IdfViewer` class for 3D visualization which is not
the main focus of this package (368).
* `run_multi()` now gets a new argument `expand_obj` to control whether
Expand Down Expand Up @@ -64,7 +64,7 @@
* Fix the error in `EplusJob$report_data()` when multiple reporting frequencies
exist in the CSV output (#340).
* Fix simulation error when FMU files are given in relative paths (#344). Now
all objects that reference to external files can be correctly copied iinto
all objects that reference to external files can be correctly copied into
output directory when `copy_external` is set to `TRUE`.
* Fix the error when using an `Idf` as input in `Idf$insert()` (#348).
* Sub-hourly EPW files are supported (#351).
Expand Down Expand Up @@ -170,9 +170,9 @@
rgl package in a similar way as OpenStudio SketchUp Plugin. `Idf$geometry()`
and `Idf$view()` methods are added to directly create an `IdfGeometry` and
`IdfViewer` object based on current `Idf` object, respectively (#296).
* A `plot.Idf` method is added which is basically a wrappper of `Idf$view()`
* A `plot.Idf` method is added which is basically a wrapper of `Idf$view()`
(#296).
* Now eplusr can utilize the CSV output for report data extraction. Benifiting
* Now eplusr can utilize the CSV output for report data extraction. Benefiting
from the fantastic `data.table::fread`, this approach can be as 3~10X faster
compared to the SQLite approach. eplusr will still use the SQLite if the CSV
output is not available.
Expand Down Expand Up @@ -209,7 +209,7 @@
value-relation extraction. It can be used to specify how to handle
class-name-references. Class name references refer to references in like
field `Component 1 Object Type` in `Branch` objects. Their value refers to
other many class names of objects, instaed of refering to specific field
other many class names of objects, instaed of referring to specific field
values. There are 3 options in total, i.e. `"none"`, `"both"` and `"all"`,
with `"both"` being the default.

Expand Down Expand Up @@ -254,7 +254,7 @@

## Bug fixes

* Fix the bug caused by `ExpandObjects` exectuable that causes `run_idf` fails
* Fix the bug caused by `ExpandObjects` executable that causes `run_idf` fails
when running in parallel (#130)
* `Idf$insert()` now will remove all duplicated objects in input (#219).
* Fix the bug in `install_eplus()` on Windows (#230)
Expand Down Expand Up @@ -405,7 +405,7 @@
install_eplus(8.8, local = TRUE, dir = "~/MyPrograms")
```
Please see `?install_eplus` for details.
* All documentation in R6 classes have been update thanks to roxyten2 R6 support (#156).
* All documentation in R6 classes have been update thanks to roxygen2 R6 support (#156).
* Deprecated methods in each class have all been remove (#156).
* New parameter `case` has been added in
`EplusSql$tabular_data()`. Similar like `case` parameter in
Expand Down
2 changes: 1 addition & 1 deletion R/geom.R
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ IdfGeometry <- R6Class("IdfGeometry", cloneable = FALSE,
#'
#' * `"surface_type"`: Default. Render the model by surface type model.
#' Walls, roofs, windows, doors, floors, and shading surfaces will
#' have unqiue colors.
#' have unique colors.
#' * `"boundary"`: Render the model by outside boundary condition. Only
#' surfaces that have boundary conditions will be rendered with a
#' color. All other surfaces will be white.
Expand Down
2 changes: 1 addition & 1 deletion R/idd.R
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ Idd <- R6::R6Class(classname = "Idd", cloneable = FALSE, lock_objects = FALSE,
#' Get the indices of specified classes
#'
#' @details
#' `$class_index()` returns the indices of specifed classes in
#' `$class_index()` returns the indices of specified classes in
#' current `Idd`. A class index is just an integer indicating its
#' appearance order in the `Idd`.
#'
Expand Down
8 changes: 4 additions & 4 deletions R/idf.R
Original file line number Diff line number Diff line change
Expand Up @@ -785,7 +785,7 @@ Idf <- R6::R6Class(classname = "Idf", lock_objects = FALSE,
#' @param class_ref Specify how to handle class-name-references. Class
#' name references refer to references in like field `Component 1
#' Object Type` in `Branch` objects. Their value refers to other
#' many class names of objects, instaed of refering to specific
#' many class names of objects, instaed of referring to specific
#' field values. There are 3 options in total, i.e. `"none"`,
#' `"both"` and `"all"`, with `"both"` being the default.
#' * `"none"`: just ignore class-name-references. It is a reasonable
Expand Down Expand Up @@ -1108,7 +1108,7 @@ Idf <- R6::R6Class(classname = "Idf", lock_objects = FALSE,
#' `=`. The main difference is that, unlike `=`, the left hand side of
#' `:=` should be a valid class name in current `Idf` object. It will
#' set the field of all objects in specified class to specified value.
#' * `.(object, object) := list(field = value)`: Simimar like above, but
#' * `.(object, object) := list(field = value)`: Similar like above, but
#' note the use of `.()` in the left hand side. You can put multiple
#' object ID or names in `.()`. It will set the field of all specified
#' objects to specified value.
Expand Down Expand Up @@ -2517,7 +2517,7 @@ Idf <- R6::R6Class(classname = "Idf", lock_objects = FALSE,
#'
#' * `"surface_type"`: Default. Render the model by surface type
#' model. Walls, roofs, windows, doors, floors, and shading
#' surfaces will have unqiue colors.
#' surfaces will have unique colors.
#' * `"boundary"`: Render the model by outside boundary condition.
#' Only surfaces that have boundary conditions will be rendered
#' with a color. All other surfaces will be white.
Expand All @@ -2533,7 +2533,7 @@ Idf <- R6::R6Class(classname = "Idf", lock_objects = FALSE,
#' @param wireframe If `TRUE`, the wireframe of each surface will be
#' shown. Default: `TRUE`.
#'
#' @param x_ray If `TRUE`, all surfaces wll be rendered translucently.
#' @param x_ray If `TRUE`, all surfaces will be rendered translucently.
#' Default: `FALSE`.
#'
#' @return An [IdfViewer] object
Expand Down
10 changes: 5 additions & 5 deletions R/idfobj.R
Original file line number Diff line number Diff line change
Expand Up @@ -778,7 +778,7 @@ IdfObject <- R6::R6Class(classname = "IdfObject", lock_objects = FALSE,
#' @param class_ref Specify how to handle class-name-references. Class
#' name references refer to references in like field `Component 1
#' Object Type` in `Branch` objects. Their value refers to other
#' many class names of objects, instaed of refering to specific
#' many class names of objects, instaed of referring to specific
#' field values. There are 3 options in total, i.e. `"none"`,
#' `"both"` and `"all"`, with `"both"` being the default.
#' * `"none"`: just ignore class-name-references. It is a reasonable
Expand Down Expand Up @@ -852,7 +852,7 @@ IdfObject <- R6::R6Class(classname = "IdfObject", lock_objects = FALSE,
#' @param class_ref Specify how to handle class-name-references. Class
#' name references refer to references in like field `Component 1
#' Object Type` in `Branch` objects. Their value refers to other
#' many class names of objects, instaed of refering to specific
#' many class names of objects, instaed of referring to specific
#' field values. There are 3 options in total, i.e. `"none"`,
#' `"both"` and `"all"`, with `"both"` being the default.
#' * `"none"`: just ignore class-name-references. It is a reasonable
Expand Down Expand Up @@ -917,7 +917,7 @@ IdfObject <- R6::R6Class(classname = "IdfObject", lock_objects = FALSE,
#' @param class_ref Specify how to handle class-name-references. Class
#' name references refer to references in like field `Component 1
#' Object Type` in `Branch` objects. Their value refers to other
#' many class names of objects, instaed of refering to specific
#' many class names of objects, instaed of referring to specific
#' field values. There are 3 options in total, i.e. `"none"`,
#' `"both"` and `"all"`, with `"both"` being the default.
#' * `"none"`: just ignore class-name-references. It is a reasonable
Expand Down Expand Up @@ -1026,7 +1026,7 @@ IdfObject <- R6::R6Class(classname = "IdfObject", lock_objects = FALSE,
#' @param class_ref Specify how to handle class-name-references. Class
#' name references refer to references in like field `Component 1
#' Object Type` in `Branch` objects. Their value refers to other
#' many class names of objects, instaed of refering to specific
#' many class names of objects, instaed of referring to specific
#' field values. There are 3 options in total, i.e. `"none"`,
#' `"both"` and `"all"`, with `"both"` being the default.
#' * `"none"`: just ignore class-name-references. It is a reasonable
Expand Down Expand Up @@ -1089,7 +1089,7 @@ IdfObject <- R6::R6Class(classname = "IdfObject", lock_objects = FALSE,
#' @param class_ref Specify how to handle class-name-references. Class
#' name references refer to references in like field `Component 1
#' Object Type` in `Branch` objects. Their value refers to other
#' many class names of objects, instaed of refering to specific
#' many class names of objects, instaed of referring to specific
#' field values. There are 3 options in total, i.e. `"none"`,
#' `"both"` and `"all"`, with `"both"` being the default.
#' * `"none"`: just ignore class-name-references. It is a reasonable
Expand Down
2 changes: 1 addition & 1 deletion R/impl-idf.R
Original file line number Diff line number Diff line change
Expand Up @@ -1970,7 +1970,7 @@ match_idd_field <- function (idd_env, dt_field) {
#' Default: `FALSE`.
#'
#' @param .strict If `TRUE`, make sure all input objects come from the same
#' verion as that from `idf_env`. Default: `TRUE`.
#' version as that from `idf_env`. Default: `TRUE`.
#'
#' @return A named list of 3 [data.table::data.table()]: `meta`, `object` and
#' `value`.
Expand Down
2 changes: 1 addition & 1 deletion R/param.R
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ ParametricJob <- R6::R6Class(classname = "ParametricJob", cloneable = FALSE,
#' @details
#' `$apply_measure()` allows to apply a measure to an [Idf] and creates
#' parametric models for analysis. Basically, a measure is just a
#' function that takes an [Idf] object and other arguments as input, and
#' function that takes an [Idf] object and other arguements as input, and
#' returns a modified [Idf] object as output. Use `...` to supply
#' different arguments, **except for the first `Idf` argument**, to that
#' measure. Under the hook, [base::mapply()] is used to create multiple
Expand Down
2 changes: 1 addition & 1 deletion R/run.R
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ clean_wd <- function (path) {
#'
#' | No. | Column | Type | Description |
#' | ---: | ----- | ----- | ----- |
#' | 1 | `index` | `integer` | Index of simuation |
#' | 1 | `index` | `integer` | Index of simulation |
#' | 2 | `status` | `character` | Simulation status |
#' | 3 | `idf` | `character` | Full path of input IDF file |
#' | 4 | `epw` | `character` | Full path of input EPW file. `NA` for design-day-only simulation |
Expand Down
2 changes: 1 addition & 1 deletion R/viewer.R
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ IdfViewer <- R6Class("IdfViewer", cloneable = FALSE,
#'
#' * `"surface_type"`: Default. Render the model by surface type
#' model. Walls, roofs, windows, doors, floors, and shading
#' surfaces will have unqiue colors.
#' surfaces will have unique colors.
#' * `"boundary"`: Render the model by outside boundary condition.
#' Only surfaces that have boundary conditions will be rendered
#' with a color. All other surfaces will be white.
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Please see these vignettes and articles about {eplusr}

* [Introduction to eplusr](https://hongyuanjia.github.io/eplusr/articles/eplusr.html)
* [Run simulation and data exploration](https://hongyuanjia.github.io/eplusr/articles/job.html)
* [Rarametric simulations](https://hongyuanjia.github.io/eplusr/articles/param.html)
* [Parametric simulations](https://hongyuanjia.github.io/eplusr/articles/param.html)
* [Update IDF version](https://hongyuanjia.github.io/eplusr/articles/transition.html)
* [Work with weather files](https://hongyuanjia.github.io/eplusr/articles/epw.html)
* [Work with `Schedule:Compact` objects](https://hongyuanjia.github.io/eplusr/articles/schedule.html)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Please see these vignettes and articles about {eplusr}
eplusr](https://hongyuanjia.github.io/eplusr/articles/eplusr.html)
- [Run simulation and data
exploration](https://hongyuanjia.github.io/eplusr/articles/job.html)
- [Rarametric
- [Parametric
simulations](https://hongyuanjia.github.io/eplusr/articles/param.html)
- [Update IDF
version](https://hongyuanjia.github.io/eplusr/articles/transition.html)
Expand Down
9 changes: 4 additions & 5 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# Version 0.13.0
# Version 0.14.0

## Resubmission

### Test environments

* local Manjaro Linux 18.0.4 install, R 3.6.1
* Windows (on appveyor-ci), R release
* Ubuntu 14.04 (on travis-ci), R release and devel
* OS X (on travis-ci), R release
* Windows (on local and GitHub Actions), R release
* Ubuntu 20.04 (on GitHub Actions), R release
* macOS (on GitHub Actions), R release

### R CMD check results

Expand Down
2 changes: 1 addition & 1 deletion man/Idd.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/Idf.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/IdfGeometry.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 53ecf2b

Please sign in to comment.