README & CAUTION

.Rbuildignore

@@ -18,4 +18,9 @@ computing
 ^.*\.Rproj$
 ^\.Rproj\.user$
 README.Rmd
-README.md
+README.md
+CAUTION.md
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^\.github$

CAUTION.md

@@ -0,0 +1,14 @@
+
+Use `R CMD check` to  check this package, not **RStudio**! 
+
+Indeed, in the check, **RStudio** deletes the `inst/doc` directory
+without warning. However this directory used here is conforming to
+section 1.4 in the [Writing R Extensions
+manual](https://cran.r-project.org/doc/manuals/R-exts.html)
+
+"*In addition to the help files in Rd format, R packages allow the
+inclusion of documents in arbitrary other formats. The standard
+location for these is subdirectory `inst/doc` of a source package, ...*"
+
+In the present case `inst/doc` contains `RenextGuide.pdf` as well as
+its source files.

DESCRIPTION

@@ -5,7 +5,7 @@ Version: 3.1-4
 Date: 2023-08-29
 Author: Yves Deville <deville.yves@alpestat.com>, Lise Bardet <lise.bardet@irsn.fr>
 Maintainer: Yann Richet <yann.richet@irsn.fr>
-URL: https://github.com/IRSN/Renext
+URL: https://github.com/IRSN/Renext, https://irsn.github.io/Renext/
 Depends: R (>= 2.8.0), stats, graphics, evd
 Imports: numDeriv, splines, methods
 Suggests: MASS, ismev, XML

README.Rmd

@@ -1,5 +1,5 @@
 ---
-title: "Renext README"
+title: "R Package Renext"
 linkcolor: blue
 output: github_document
 ---
@@ -14,14 +14,22 @@ output: github_document
 
 <!-- README.md is generated from README.Rmd. Please edit htat file -->
 
-## Renext package
+## Renext
 
 This repository contains the complete source code of the **Renext**
 package, released on CRAN since 2010. The package is still maintained
 but no new development is planned.
 
-The [Renext Computing
-Details](https://github.com/IRSN/Renext/blob/main/inst/computing/RenextCompDet.pdf)
-document is available here, but is not included in the package source
-tarball `tar.gz`. Although this document is more than 10 years old, it 
-is re-compiled from time to time with slight fixes/changes.
+The package does not have any vignette as such, yet
+
+- The [Renext
+  Guide](https://github.com/IRSN/Renext/blob/main/inst/doc/RenextGuide.pdf)
+  available here is shipped with the package as a pdf file (with extra
+  compression).
+
+- The [Renext Computing
+   Details](https://github.com/IRSN/Renext/blob/main/inst/computing/RenextCompDet.pdf)
+   document is available here, but is not included in the package
+   source tarball `tar.gz`. Although this document is more than 10
+   years old, it is re-compiled from time to time with slight
+   fixes/changes.

README.md

@@ -1,4 +1,4 @@
-Renext README
+R Package Renext
 ================
 
 <!-- badges: start -->
@@ -14,14 +14,21 @@ status](https://www.r-pkg.org/badges/version/Renext)](https://cran.r-project.org
 <!-- badges: end -->
 <!-- README.md is generated from README.Rmd. Please edit htat file -->
 
-## Renext package
+## Renext
 
 This repository contains the complete source code of the **Renext**
 package, released on CRAN since 2010. The package is still maintained
 but no new development is planned.
 
-The [Renext Computing
-Details](https://github.com/IRSN/Renext/blob/main/inst/computing/RenextCompDet.pdf)
-document is available here, but is not included in the package source
-tarball `tar.gz`. Although this document is more than 10 years old, it
-is re-compiled from time to time with slight fixes/changes.
+The package does not have any vignette as such, yet
+
+- The [Renext
+  Guide](https://github.com/IRSN/Renext/blob/main/inst/doc/RenextGuide.pdf)
+  available here is shipped with the package as a pdf file (with extra
+  compression).
+
+- The [Renext Computing
+  Details](https://github.com/IRSN/Renext/blob/main/inst/computing/RenextCompDet.pdf)
+  document is available here, but is not included in the package source
+  tarball `tar.gz`. Although this document is more than 10 years old, it
+  is re-compiled from time to time with slight fixes/changes.