Initial CRAN release

sebffischer · web-flow · commit 37be269324a7 · 2024-04-09T08:57:16.000+02:00
* prepare CRAN release

* update authors

* typo

* update authors

* desc: update description

* release 0.1.0
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -26,3 +26,4 @@
 ^pkgdown$
 ^revdep$
 ^tic\.R$
+^cran-comments\.md$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -5,9 +5,19 @@ Authors@R: c(
     person("Sebastian", "Fischer", , "sebf.fischer@gmail.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-9609-3197")),
     person("Maximilian", "Muecke", , "muecke.maximilian@gmail.com", role = "aut",
-           comment = c(ORCID = "0009-0000-9432-9795"))
+           comment = c(ORCID = "0009-0000-9432-9795")),
+    person("Fabian", "Scheipl", email = "fabian.scheipl@googlemail.com", role = "ctb",
+           comment = c(ORCID = "0000-0001-8172-3603")),
+    person("Bernd", "Bischl", , "bernd_bischl@gmx.net", role = "ctb",
+           comment = c(ORCID = "0000-0001-6002-6980"))
   )
-Description: Provides extensions for functional data analysis for 'mlr3'.
+Description: Extends the 'mlr3' ecosystem to functional analysis by adding support
+    for irregular and regular functional data as defined in the 'tf' package.
+    The package provides 'PipeOps' for preprocessing functional columns and for
+    extracting scalar features, thereby allowing standard machine learning
+    algorithms to be applied afterwards. Available operations include simple
+    functional features such as the mean or maximum, smoothing, interpolation,
+    flattening, and functional 'PCA'.
 License: LGPL-3
 URL: https://mlr3fda.mlr-org.com, https://github.com/mlr-org/mlr3fda
 BugReports: https://github.com/mlr-org/mlr3fda/issues
@@ -26,7 +36,6 @@ Imports:
 Suggests:
     rpart,
     testthat (>= 3.0.0),
-    pracma,
     zoo
 Config/testthat/edition: 3
 Encoding: UTF-8
diff --git a/README.Rmd b/README.Rmd
@@ -33,10 +33,12 @@ Extending mlr3 to functional data.
 
 ## Installation
 
-This package is not yet on CRAN but you can install the development version of `mlr3fda` from [GitHub](https://github.com/) with:
+You can either install the latest release from CRAN, or the development version from [GitHub](https://github.com/):
 
 ```{r, eval = FALSE}
-# install.packages("pak")
+# install from CRAN
+install.packages("mlr3fda")
+# install from GitHub
 pak::pak("mlr-org/mlr3fda")
 ```
 
diff --git a/README.md b/README.md
@@ -17,11 +17,13 @@ status](https://www.r-pkg.org/badges/version/mlr3fda)](https://CRAN.R-project.or
 
 ## Installation
 
-This package is not yet on CRAN but you can install the development
-version of `mlr3fda` from [GitHub](https://github.com/) with:
+You can either install the latest release from CRAN, or the development
+version from [GitHub](https://github.com/):
 
 ``` r
-# install.packages("pak")
+# install from CRAN
+install.packages("mlr3fda")
+# install from GitHub
 pak::pak("mlr-org/mlr3fda")
 ```
 
diff --git a/cran-comments.md b/cran-comments.md
@@ -0,0 +1,5 @@
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.
diff --git a/man/mlr3fda-package.Rd b/man/mlr3fda-package.Rd
