prep for initial cran release

cneyens · Jul 28, 2024 · cddb152 · cddb152
1 parent 8edd7e1
commit cddb152
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 2 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -7,3 +7,4 @@
 ^docs$
 ^pkgdown$
 ^codecov\.yml$
+^cran-comments\.md$
diff --git a/NEWS.md b/NEWS.md
@@ -0,0 +1,3 @@
+# raem 0.1.0
+
+* Initial CRAN submission.
diff --git a/README.Rmd b/README.Rmd
@@ -30,7 +30,13 @@ knitr::opts_knit$set(
 
 ## Installation
 
-You can install the development version of `raem` from [GitHub](https://github.com/cneyens/raem) with:
+To install the released version:
+
+``` r
+install.packages("raem")
+```
+
+The development version of `raem` can be installed from [GitHub](https://github.com/cneyens/raem) with:
 
 ``` r
 # install.packages("devtools")

diff --git a/README.md b/README.md
@@ -18,7 +18,13 @@ elements.
 
 ## Installation
 
-You can install the development version of `raem` from
+To install the released version:
+
+``` r
+install.packages("raem")
+```
+
+The development version of `raem` can be installed from
 [GitHub](https://github.com/cneyens/raem) with:
 
 ``` r

diff --git a/cran-comments.md b/cran-comments.md
@@ -0,0 +1,16 @@
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.
+
+* checking examples ... [32s] NOTE
+  Examples with CPU (user + system) or elapsed time > 5s
+              user system elapsed
+  capzone    16.41   0.28   17.02
+  tracelines 12.42   0.33   14.34
+
+  The underlying computations require numerical integration which is slow. 
+  Reducing the run time of the examples would require changing them in such a way that 
+  they are no longer meaningful examples.
+