0.9.0 Release

KentonWhite · Feb 26, 2019 · 899ee41 · 899ee41
1 parent 27affaa
commit 899ee41
Show file tree

Hide file tree

Showing 18 changed files with 79 additions and 33 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,8 @@
 Package: ProjectTemplate
 Type: Package
 Title: Automates the Creation of New Statistical Analysis Projects
-Version: 0.8.2
-Date: 2018-04-20
+Version: 0.9.0
+Date: 2019-02-26
 Authors@R: c( person("Aleksandar", "Blagotic", role = "ctb"),
     person("Diego", "Valle-Jones", role = "ctb"),
     person("Jeffrey", "Breen", role = "ctb"),
@@ -23,6 +23,7 @@ Description: Provides functions to
 License: GPL-3 | file LICENSE
 LazyLoad: yes
 Roxygen: list(wrap = FALSE)
+Encoding: UTF-8
 Depends:
     R (>= 2.7)
 Suggests:
@@ -108,4 +109,4 @@ Collate:
     'xls.reader.R'
     'xlsx.reader.R'
     'xport.reader.R'
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.1
diff --git a/NAMESPACE b/NAMESPACE
@@ -29,5 +29,6 @@ importFrom(utils,download.file)
 importFrom(utils,install.packages)
 importFrom(utils,modifyList)
 importFrom(utils,read.csv)
+importFrom(utils,read.csv2)
 importFrom(utils,read.table)
 importFrom(utils,unzip)
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,27 @@
 # ProjectTemplate 0.8.2 (2018-04-20)
 
+0.9.0 (2019-02-26)
+
+Features
+--------
+* New for R 3.6, support for staged install (#291)
+* Define default table types using config var `tables_type` (#274)
+* Support for `feather` files (#239)
+* Migration from `csv2.reader` to `read.csv2` (#195)
+* Supports `rstudio.project` files (#201)
+
+Documentation
+-------------
+* Link website documentation current release to News.md
+* Added file types to `dat` directory `README` (#268)
+* Internal functions are now documenter (#243)
+
+Internal
+--------
+* `data_ignore` applies to `cache` vars (#290)
+* More informative error messages if not in a ProjectTemplate Directory (#287)
+* `migrate_project()` creates missing `cache` directory (#275) 
+
 0.8.2 (2018-04-20)
 
 Features
@@ -188,7 +210,7 @@ v0.4-4 (2013-08-11)
 * Fix CRAN checks (@krlmlr).
 * project.info is now an active binding to avoid writing to the global
   environment (@krlmlr).
-* Reenabled xlsx.reader (@krlmlr).
+* Re-enabled xlsx.reader (@krlmlr).
 * Added JDBC support to sql.reader (@joshbode, #12).
 * Various MySQL improvements (@cortex, #10).
 * Fix "Argument port must be an integer value" when using port number for mysql

diff --git a/R/clear.R b/R/clear.R
@@ -10,7 +10,7 @@
 #' @param keep A character vector of variables that should remain in the global
 #'  environment
 #' @param force If \code{TRUE}, then variables will be deleted even if
-#'  specifed in \code{keep} or \code{config$sticky_variables}
+#'  specified in \code{keep} or \code{config$sticky_variables}
 #'
 #' @return The variables kept and removed are reported
 #'

diff --git a/R/csv2.reader.R b/R/csv2.reader.R
@@ -3,7 +3,7 @@
 #' In May 2018, the default behaviour of the reader for .csv2 files changed to use R's read.csv2(),
 #' where the field separator is assumed to be ';' and the decimal separator to be ','.
 #'
-#' @importFrom utils read.csv
+#' @importFrom utils read.csv2
 #' @importFrom utils unzip
 csv2.reader <- function(data.file, filename, variable.name)
 {

diff --git a/R/list.data.R b/R/list.data.R
@@ -32,7 +32,7 @@
 #' }
 #'
 #' * Note that some readers return more than one variable, usually with the
-#'   listed variablename as prefix. This is true for for example the
+#'   listed variable name as prefix. This is true for for example the
 #'   \code{xls.reader} and \code{xlsx.reader}.
 #'
 #' @export

diff --git a/R/require.package.R b/R/require.package.R
@@ -54,7 +54,7 @@ require.package <- function(package.name, attach = TRUE)
 #'
 #' @keywords internal
 #'
-#' @return Boolean indicating whether the package was succesfully loaded
+#' @return Boolean indicating whether the package was successfully loaded
 #'
 #' @rdname internal.attach.or.add.namespace
 .attach.or.add.namespace <- function(package.name, attach) {

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,6 +1,6 @@
 ## Test environments
-* local Ubuntu install, R 3.3.1
-* ubuntu 12.04 (on travis-ci), R 3.3.1
+* local MacOSX install, R-devel 3.6
+* ubuntu 12.04 (on travis-ci), R 3.5.2
 * win-builder (devel and release)
 
 ## R CMD check results

diff --git a/docs/changes.markdown b/docs/changes.markdown
@@ -7,6 +7,28 @@ The raw ProjectTemplate source code is always the place to go for ground truth.
 
 The list of changes below covers all releases up to and including v0.8.2. It is not necessarily exhaustive.
 
+#### 0.9.0 (2019-02-26)
+
+###### Features
+
+* New for R 3.6, support for staged install (#291)
+* Define default table types using config var `tables_type` (#274)
+* Support for `feather` files (#239)
+* Migration from `csv2.reader` to `read.csv2` (#195)
+* Supports `rstudio.project` files (#201)
+
+##### Documentation
+
+* Link website documentation current release to News.md
+* Added file types to `dat` directory `README` (#268)
+* Internal functions are now documenter (#243)
+
+##### Internal
+
+* `data_ignore` applies to `cache` vars (#290)
+* More informative error messages if not in a ProjectTemplate Directory (#287)
+* `migrate_project()` creates missing `cache` directory (#275)
+
 #### 0.8.2 (2018-04-20)
 
 ##### Features

diff --git a/docs/configuring.markdown b/docs/configuring.markdown
@@ -23,7 +23,7 @@ The current `ProjectTemplate` configuration settings exist in the `config/global
 * `load_libraries`: This can be set to 'on' or 'off'. If `load_libraries` is on, the system will load all of the R packages listed in the `libraries` field described below. By default, `load_libraries` is off.
 * `libraries`: This is a comma separated list of all the R packages that the user wants to automatically load when `load.project()` is called. These packages must already be installed before calling `load.project()`. By default, the reshape2, plyr, tidyverse, stringr and lubridate packages are included in this list.
 * `as_factors`: This can be set to 'on' or 'off'. If `as_factors` is on, the system will convert every character vector into a factor when creating data frames; most importantly, this automatic conversion occurs when reading in data automatically. If 'off', character vectors will remain character vectors. By default, `as_factors` is on.
-* `data_tables`: This can be set to 'on' or 'off'. If `data_tables` is on, the system will convert every data set loaded from the `data` directory into a `data.table`. By default, `data_tables` is off.
+* `tables_type`: This is the format for default tables. Values can be 'tibble' (default), 'data_table', or 'data_frame'
 * `attach_internal_libraries`: This can be set to 'on' or 'off'. If `attach_internal_libraries` is on, then every time a new package is loaded into memory during `load.project()` a warning will be displayed informing that has happened. By default, `attach_internal_libraries` is off.
 * `cache_loaded_data`: This can be set to 'on' or 'off'. If `cache_loaded_data` is on, then data loaded from the `data` directory during `load.project()` will be automatically cached (so it won't need to be reloaded next time `load.project()` is called).  By default, `cache_loaded_data` is on for newly created projects.  Existing projects created without this configuration setting will default to off.  Similarly, when `migrate.project()` is called in those cases, the default will be off.
 * `sticky_variables`: This is a comma separated list of any project-specific  variables that should remain in the global environment after a `clear()` command.  This can be used to clear the global environment, but keep any large datasets in place so they are not unnecessarily re-generated during `load.project()`.  Note that any this will be over-ridden if the `force=TRUE` parameter is passed to `clear()`. By default, `sticky_variables` is NONE

diff --git a/inst/defaults/templates/full/config/global.dcf b/inst/defaults/templates/full/config/global.dcf
@@ -1,4 +1,4 @@
-version: 0.8.2
+version: 0.9.0
 data_loading: TRUE
 data_loading_header: TRUE
 data_ignore:

diff --git a/inst/defaults/templates/minimal/config/global.dcf b/inst/defaults/templates/minimal/config/global.dcf
@@ -1,4 +1,4 @@
-version: 0.8.2
+version: 0.9.0
 data_loading: TRUE
 data_loading_header: TRUE
 data_ignore:

diff --git a/man/clear.Rd b/man/clear.Rd
diff --git a/man/create.project.Rd b/man/create.project.Rd
diff --git a/man/internal.attach.or.add.namespace.Rd b/man/internal.attach.or.add.namespace.Rd
diff --git a/man/internal.list.data.Rd b/man/internal.list.data.Rd
diff --git a/man/list.data.Rd b/man/list.data.Rd
diff --git a/man/project.config.Rd b/man/project.config.Rd