Refactor and export internal functions

DESCRIPTION

@@ -20,9 +20,10 @@ Depends:
     R (>= 3.2.0)
 Imports:
     callr (>= 2.0.4),
+    checkmate,
     cli (>= 1.1.0),
     crayon,
-    data.table (>= 1.9.8),
+    data.table (>= 1.12.4),
     lubridate,
     methods,
     processx (>= 3.2.0),
@@ -38,41 +39,42 @@ Suggests:
     pkgdown,
     rgl,
     rmarkdown,
-    testthat
-VignetteBuilder: 
+    testthat (>= 2.1.0)
+VignetteBuilder:
     knitr
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE, roclets = c("rd", "namespace",
     "collate"))
-RoxygenNote: 7.0.2
+RoxygenNote: 7.1.1
 SystemRequirements: EnergyPlus (>= 8.3, optional)
     (<https://energyplus.net>); udunits2
 Collate:
     'constants.R'
-    'assertions.R'
+    'assert.R'
     'diagram.R'
     'eplusr.R'
     'utils.R'
     'impl.R'
     'parse.R'
     'impl-epw.R'
+    'impl-idd.R'
+    'impl-idf.R'
+    'idf.R'
+    'idd.R'
     'epw.R'
     'err.R'
     'format.R'
     'geometry.R'
     'group.R'
-    'impl-idd.R'
-    'idd.R'
-    'idd_object.R'
-    'impl-idf.R'
-    'idf.R'
+    'iddobj.R'
     'impl-idfobj.R'
-    'idf_object.R'
+    'idfobj.R'
     'impl-iddobj.R'
     'impl-sql.R'
     'install.R'
     'job.R'
+    'options.R'
     'param.R'
     'rdd.R'
     'reload.R'

NAMESPACE

@@ -22,7 +22,6 @@ S3method("==",Idf)
 S3method("==",IdfObject)
 S3method("==",ParametricJob)
 S3method("[",EpwDate)
-S3method("[",Idd)
 S3method("[",IdfObject)
 S3method("[<-",EpwDate)
 S3method("[[",EpwDate)
@@ -49,6 +48,7 @@ S3method(format,Idf)
 S3method(format,IdfObject)
 S3method(format,Range)
 S3method(print,EpwDate)
+S3method(print,EpwValidity)
 S3method(print,ErrFile)
 S3method(print,IddFieldPossible)
 S3method(print,IddRelation)
@@ -89,22 +89,45 @@ export(IddObject)
 export(Idf)
 export(IdfObject)
 export(ParametricJob)
+export(add_idf_object)
+export(assign_idf_value_default)
 export(avail_eplus)
 export(avail_idd)
 export(clean_wd)
 export(custom_validate)
+export(del_idf_object)
 export(download_eplus)
 export(download_idd)
 export(download_weather)
 export(dt_to_load)
+export(dup_idf_object)
+export(duplicated_idf_object)
 export(empty_idf)
 export(eplus_config)
 export(eplus_job)
 export(eplus_sql)
 export(eplusr_option)
+export(expand_idf_dots_literal)
+export(expand_idf_dots_name)
+export(expand_idf_dots_object)
+export(expand_idf_dots_value)
+export(expand_idf_regex)
+export(get_idd_class)
+export(get_idd_field)
+export(get_idd_relation)
+export(get_idf_node_relation)
+export(get_idf_object)
+export(get_idf_relation)
+export(get_idf_table)
+export(get_idf_value)
+export(get_object_info)
+export(get_priv_env)
+export(get_self_env)
 export(group_job)
 export(idd_object)
 export(idf_object)
+export(init_idf_object)
+export(init_idf_value)
 export(install_eplus)
 export(is_avail_eplus)
 export(is_avail_idd)
@@ -117,20 +140,31 @@ export(is_iddobject)
 export(is_idf)
 export(is_idfobject)
 export(level_checks)
+export(make_idf_object_name)
 export(mdd_to_load)
 export(param_job)
+export(parse_dots_value)
+export(purge_idf_object)
 export(rdd_to_load)
 export(read_epw)
 export(read_err)
 export(read_idf)
+export(read_idfeditor_copy)
 export(read_mdd)
 export(read_rdd)
 export(reload)
+export(remove_duplicated_objects)
+export(remove_empty_fields)
+export(rename_idf_object)
 export(run_idf)
 export(run_multi)
+export(set_idf_object)
+export(standardize_idf_value)
 export(transition)
+export(unique_idf_object)
 export(use_eplus)
 export(use_idd)
+export(validate_objects)
 export(version_updater)
 export(with_option)
 export(with_silent)
@@ -144,11 +178,54 @@ importFrom(RSQLite,dbGetQuery)
 importFrom(RSQLite,dbListTables)
 importFrom(RSQLite,dbReadTable)
 importFrom(callr,r_bg)
+importFrom(checkmate,assert)
+importFrom(checkmate,assert_character)
+importFrom(checkmate,assert_choice)
+importFrom(checkmate,assert_class)
+importFrom(checkmate,assert_count)
+importFrom(checkmate,assert_data_frame)
+importFrom(checkmate,assert_data_table)
+importFrom(checkmate,assert_directory_exists)
+importFrom(checkmate,assert_file)
+importFrom(checkmate,assert_file_exists)
+importFrom(checkmate,assert_flag)
+importFrom(checkmate,assert_function)
+importFrom(checkmate,assert_int)
+importFrom(checkmate,assert_integer)
+importFrom(checkmate,assert_integerish)
+importFrom(checkmate,assert_list)
+importFrom(checkmate,assert_logical)
+importFrom(checkmate,assert_names)
+importFrom(checkmate,assert_number)
+importFrom(checkmate,assert_numeric)
+importFrom(checkmate,assert_posixct)
+importFrom(checkmate,assert_scalar)
+importFrom(checkmate,assert_string)
+importFrom(checkmate,assert_subset)
+importFrom(checkmate,assert_true)
+importFrom(checkmate,assert_vector)
+importFrom(checkmate,check_character)
+importFrom(checkmate,check_integerish)
+importFrom(checkmate,check_string)
+importFrom(checkmate,qassert)
+importFrom(checkmate,qassertr)
+importFrom(checkmate,qtestr)
+importFrom(checkmate,test_character)
+importFrom(checkmate,test_choice)
+importFrom(checkmate,test_class)
+importFrom(checkmate,test_file_exists)
+importFrom(checkmate,test_flag)
+importFrom(checkmate,test_integerish)
+importFrom(checkmate,test_list)
+importFrom(checkmate,test_names)
+importFrom(checkmate,test_r6)
+importFrom(checkmate,test_string)
 importFrom(cli,boxx)
 importFrom(cli,cat_boxx)
 importFrom(cli,cat_bullet)
 importFrom(cli,cat_line)
 importFrom(cli,cat_rule)
+importFrom(cli,console_width)
 importFrom(cli,rule)
 importFrom(cli,symbol)
 importFrom(crayon,bold)
@@ -174,9 +251,11 @@ importFrom(data.table,setDT)
 importFrom(data.table,setattr)
 importFrom(data.table,setcolorder)
 importFrom(data.table,setindexv)
+importFrom(data.table,setnafill)
 importFrom(data.table,setnames)
 importFrom(data.table,setorder)
 importFrom(data.table,setorderv)
+importFrom(data.table,transpose)
 importFrom(grDevices,rgb)
 importFrom(lubridate,"year<-")
 importFrom(lubridate,as_datetime)
@@ -213,6 +292,7 @@ importFrom(stringi,stri_endswith_fixed)
 importFrom(stringi,stri_extract_first_regex)
 importFrom(stringi,stri_isempty)
 importFrom(stringi,stri_length)
+importFrom(stringi,stri_locate_first_charclass)
 importFrom(stringi,stri_locate_first_fixed)
 importFrom(stringi,stri_locate_first_regex)
 importFrom(stringi,stri_match_first_regex)

NEWS.md

@@ -2,6 +2,17 @@
 
 ## New features
 
+* `Idf$add()` and `Idf$set()` have new features:
+
+  ```r
+  # refer to field using '..'
+  idf$add(Material = list(..1 = "mat", ..7 = 0.95))
+  idf$set(mat = list(..6 = 0.5))
+
+  # using vector field values
+  idf$add(Material := list(..1 = sprintf("mat%i", 1:10)))
+  idf$set(c(sprintf("mat%i", 1:10)) := list(..6 = runif(10)))
+  ```
 * `Idf$to_table()` gains a new parameter `force`. The default value is `FALSE`. If
   `TRUE`, you can convert object data from any classes into a wide data.table.
   This may be useful when you know that target classes have the exact same
@@ -60,6 +71,8 @@
   - `"CustomDay"`: CustomDay1 and CustomDay2
   - `"SpecialDay"`: Equivalent to `"DesignDay"` plus `"CustomDay"`
   - `"NormalDay"`: Equivalent to `"Weekday"` and `"Weekend"` plus `"Holiday"`
+* Some internal functions have been exported. They are mainly useful for
+  developers to handle internal IDD and IDF data more efficiently.
 
 ## Major changes
 
@@ -110,25 +123,25 @@
     value of field `Component 1 Object Type` is `Coil:Heating:Water`, all
     objects in `Coil:Heating:Water` will be treated as referenced by that
     field. This is the most aggressive option.
-* `read_epw()` will proceed parsing if type error occurs for non-important
-  headers, including `LOCATION`, `DESIGN CONDITIONS`, `TYPICAL/EXTREME PERIODS`
-  and `GROUND TEMPERATURES` (#236). These headers are not directly used in any
-  other method of `Epw` class. Some EPWs from sources other than energyplus.net
-  sometimes fail to give all valid values for those headers. Now `read_epw()`
-  will return all failed-to-parse values as `NA`s. All parsing warnings can be
-  shown by setting `warning` in `read_epw()` to `TRUE`. For `HOLIDAYS/DAYLIGHT
-  SAVINGS` and `DATA PERIODS`, `read_epw()` will still give an error if any
-  parsing errors are found. This is because the values of those 2 headers are
-  used to parsing the actual weather data.
+* `read_epw()` will proceed parsing for non-standard EPW header format (#236).
 * Now `EplusSql$report_data()` will set the year values of day type
   `SummerDesignDay` and `WinterDesignDay` to current year and the `day_type`
   value will be left unchanged (#258).
+* Now `read_idf()` will always make sure all necessary fields are added during
+  parsing (#267).
 
 ## Minor changes
 
 * `EplusJob`, `EplusGroupJob` and `ParametricJob` will not parse input EPW
   files, but only validate their existences and store the paths (#215)
 * `period` parameter in  `EplusSql$report_data()` now works as expected (#259).
+* `run_idf()` and `run_multi()` now return additional element/column called
+* `version` which contain the versions of EnergyPlus that are called during
+  simulations
+* `format.Idd()` now returns a single line string in format
+  `<EnergyPlus IDD v[Version] (Build) with X classes`.
+* The column `datasource` returned in `Epw$data()` has been renamed to
+  `data_source`.
 
 ## Bug fixes