Prepare for initial release.

Author: astamm

.Rbuildignore

@@ -11,3 +11,4 @@
 ^pkgdown$
 ^[.]?air[.]toml$
 ^\.vscode$
+^cran-comments\.md$

NEWS.md

@@ -1,3 +1,34 @@
-# inphr (development version)
+# inphr 0.0.1
 
-* Initial CRAN submission.
+This is a new submission to CRAN.
+
+## Goals
+
+The [{inphr}](https://tdaverse.github.io/inphr/) package is intended to be a
+package for making inference on samples of persistence homology data. It is 
+part of the *TDAverse* suite of packages, which are designed to provide a
+collection of packages for enabling machine learning and data science tasks
+using persistent homology.
+
+## Current features
+
+The package currently exposes two main functions which test if two samples of PH data have been generated from the same distribution:
+
+- [`two_sample_diagram_test()`](https://tdaverse.github.io/inphr/reference/two_sample_diagram_test.html) works in the space of diagrams, using test statistics based on inter-point distances only.
+- [`two_sample_functional_test()`](https://tdaverse.github.io/inphr/reference/two_sample_functional_test.html) works in a functional space (one of Betti, Euler characteristic, normalized life, silhouette or entropy) and uses interval-wise testing (providing strong control of familywise error rate) to output on which portions of the scale sequence does the difference occur.
+
+## Dependencies
+
+Messages, warnings and errors are relayed to the user using the
+[{rlang}](https://rlang.r-lib.org) package and the
+[{cli}](https://cli.r-lib.org) package which are both licensed under the MIT
+license and with no dependency trail.
+
+Inference in the space of diagrams is performed thanks to the combination of
+[{phutil}](https://cran.r-project.org/package=phutil) which computes distances between diagrams in an efficient manner and
+[{flipr}](https://cran.r-project.org/package=flipr) which powers the permutation schemes and test statistics based on
+inter-point distances.
+
+Inference in functional spaces is performed thanks to the combination of
+[{TDAvec}](https://cran.r-project.org/package=TDAvec) which provides the suitable PH vectorization and [{fdatest}](https://cran.r-project.org/package=fdatest) which
+powers the interval-wise testing procedure for functional data.

R/two-sample-functional-test.R

@@ -46,7 +46,7 @@
 #'
 #' @export
 #' @examples
-#' out <- two_sample_functional_test(trefoils1, archspirals, B = 100L, scale_size = 50L)
+#' out <- two_sample_functional_test(trefoils1, archspirals, B = 10L, scale_size = 20L)
 #' plot(out$iwt, xrange = range(out$scale_seq))
 #' matplot(
 #'   out$scale_seq[-1],

README.Rmd

@@ -18,6 +18,7 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 [![Codecov test coverage](https://codecov.io/gh/tdaverse/inphr/graph/badge.svg)](https://app.codecov.io/gh/tdaverse/inphr)
 [![R-CMD-check](https://github.com/tdaverse/inphr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tdaverse/inphr/actions/workflows/R-CMD-check.yaml)
+[![CRAN status](https://www.r-pkg.org/badges/version/inphr)](https://CRAN.R-project.org/package=inphr)
 <!-- badges: end -->
 
 The goal of [{inphr}](https://tdaverse.github.io/inphr/) is to provide a set of

README.md

@@ -8,6 +8,8 @@
 [![Codecov test
 coverage](https://codecov.io/gh/tdaverse/inphr/graph/badge.svg)](https://app.codecov.io/gh/tdaverse/inphr)
 [![R-CMD-check](https://github.com/tdaverse/inphr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tdaverse/inphr/actions/workflows/R-CMD-check.yaml)
+[![CRAN
+status](https://www.r-pkg.org/badges/version/inphr)](https://CRAN.R-project.org/package=inphr)
 <!-- badges: end -->
 
 The goal of [{inphr}](https://tdaverse.github.io/inphr/) is to provide a

cran-comments.md

@@ -0,0 +1,19 @@
+## Test environments
+
+* local macOS R installation, R 4.5.1
+* continuous integration via GH actions:
+  * macOS latest release
+  * windows latest release
+  * ubuntu 24.04.2 LTS and devel and oldrel-1
+* [win-builder](https://win-builder.r-project.org/) (release and devel)
+* [macOS-builder](https://mac.r-project.org/macbuilder/submit.html)
+* [R-hub](https://r-hub.github.io/rhub/): All platforms expect
+  * `gcc14` for which package {pcaPP} fails to install;
+  * `intel` which fails to install because it cannot find `libquadmath.so` required by {TDAvec} dependency;
+  * `mkl` which fails to install because it cannot find symbol `mkl_lapack_dcombssq` required by {TDAvec} dependency.
+
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.