diff --git a/DESCRIPTION b/DESCRIPTION index c5b33411..fe7ea183 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: FFTrees Type: Package Title: Generate, Visualise, and Evaluate Fast-and-Frugal Decision Trees -Version: 2.0.0.9008 -Date: 2023-08-15 +Version: 2.0.0.9009 +Date: 2023-08-23 Authors@R: c(person("Nathaniel", "Phillips", role = c("aut"), email = "Nathaniel.D.Phillips.is@gmail.com", comment = c(ORCID = "0000-0002-8969-7013")), person("Hansjoerg", "Neth", role = c("aut", "cre"), email = "h.neth@uni.kn", comment = c(ORCID = "0000-0001-5427-3141")), person("Jan", "Woike", role = "aut", comment = c(ORCID = "0000-0002-6816-121X")), diff --git a/NEWS.md b/NEWS.md index cb6d0260..277b637d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,7 +1,7 @@ # FFTrees 2.0 -## 2.0.0.9007 +## 2.0.0.9009 @@ -20,7 +20,7 @@ Changes since last release: -- Adding support for handling NA values. +- Added support for handling NA values. @@ -38,7 +38,7 @@ Changes since last release: -- None yet. +- Added `@aliases FFTrees-package` to documentation main `FFTrees()` function. @@ -46,6 +46,8 @@ Changes since last release: The current development version of **FFTrees** is available at . +------ + ## 2.0.0 @@ -522,6 +524,6 @@ Thus, the main tree building function is now `FFTrees()` and the new tree object ------ -[File `NEWS.md` last updated on 2023-07-07.] +[File `NEWS.md` last updated on 2023-08-23.] diff --git a/R/FFTrees.R b/R/FFTrees.R index 9028b94c..4ed9ee73 100644 --- a/R/FFTrees.R +++ b/R/FFTrees.R @@ -179,6 +179,8 @@ #' # Plot the (pretty bad) custom tree: #' plot(custom.fft) #' +#' @aliases FFTrees-package +#' #' @seealso #' \code{\link{print.FFTrees}} for printing FFTs; #' \code{\link{plot.FFTrees}} for plotting FFTs; diff --git a/README.Rmd b/README.Rmd index fa8b160d..bf41fd3b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -40,11 +40,13 @@ url_JDM_doi <- "https://doi.org/10.1017/S1930297500006239" [![R-CMD-check](https://github.com/ndphillips/FFTrees/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ndphillips/FFTrees/actions/workflows/R-CMD-check.yaml) + + @@ -54,6 +56,7 @@ url_JDM_doi <- "https://doi.org/10.1017/S1930297500006239" + The R package **FFTrees** creates, visualizes and evaluates _fast-and-frugal decision trees_ (FFTs) for solving binary classification tasks, using the algorithms and methods described in Phillips, Neth, Woike & Gaissmaier (2017, doi\ [10.1017/S1930297500006239](`r url_JDM_doi`) | [html](`r url_JDM_html`) | [PDF](`r url_JDM_pdf`)). diff --git a/README.md b/README.md index 5d7569b5..ebb8387e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -# FFTrees 2.0.0.9008 FFTrees +# FFTrees 2.0.0.9009 FFTrees @@ -343,6 +343,6 @@ Examples include: ------------------------------------------------------------------------ -\[File `README.Rmd` last updated on 2023-08-15.\] +\[File `README.Rmd` last updated on 2023-08-23.\] diff --git a/man/FFTrees.Rd b/man/FFTrees.Rd index 8253194f..7330193c 100644 --- a/man/FFTrees.Rd +++ b/man/FFTrees.Rd @@ -3,6 +3,7 @@ \docType{package} \name{FFTrees} \alias{FFTrees} +\alias{FFTrees-package} \title{Main function to create and apply fast-and-frugal trees (FFTs)} \usage{ FFTrees(