docs: solve some warnings about doc generation with roxygen2

.gitignore

@@ -2,6 +2,8 @@
 .Rhistory
 .RData
 .Ruserdata
+.settings
+.project
 src/*.o
 src/*.so
 src/*.dll

DESCRIPTION

@@ -31,4 +31,4 @@ Author: Alban de Lavenne [aut, cre] (<https://orcid.org/0000-0002-9448-3490>),
   Tom Loree [ctb],
   Hervé Squividant [ctb]
 Maintainer: Alban de Lavenne <alban.delavenne@inrae.fr>
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2

R/utils.R

@@ -11,6 +11,8 @@ uh2mat <- function(uh,nrow,ncol){
   return(mat)
 }
 
+#' @method solve units
+#' @noRd
 solve.units <- function(a, ...){
   x <- drop_units(a)
   y <- solve(x)
@@ -19,10 +21,15 @@ solve.units <- function(a, ...){
 }
 
 #' @method %*% transfR
+#' @noRd
 '%*%' <- function(x,...) UseMethod('%*%',x)
 
+#' @method %*% default
+#' @noRd
 '%*%.default' <- .Primitive('%*%')
 
+#' @method %*% units
+#' @noRd
 '%*%.units' <-  function(e1, e2){
   x1 <- drop_units(e1)
   x2 <- drop_units(e2)

man/Blavet.Rd

@@ -12,12 +12,12 @@
 \description{
 'Blavet' is a dataset of the Blavet French river in Brittany peninsula and two neighouring rivers (Claie and Coët-Organ). It contains all the necessary inputs to test the package and perform discharge prediction at the outlet of six catchments:
 \itemize{
-  \item {J5613010}  {Evel at Guénin (316 km²)}
-  \item {J5618310}  {Fremeur et Guénin (15.1 km²)}
-  \item {J5618320}  {Fremeur et Pluméliau (5.88 km²)}
-  \item {J5704810}  {Coët-Organ at Quistinic (47.7 km²)}
-  \item {J8433020}  {Claie at Saint-Jean-Brévelay (135 km²)}
-  \item {AgrHys}  {Coët-Dan at Naizin (4.9 km²)}
+  \item J5613010: Evel at Guénin (316 km²)
+  \item J5618310: Fremeur et Guénin (15.1 km²)
+  \item J5618320: Fremeur et Pluméliau (5.88 km²)
+  \item J5704810: Coët-Organ at Quistinic (47.7 km²)
+  \item J8433020: Claie at Saint-Jean-Brévelay (135 km²)
+  \item AgrHys: Coët-Dan at Naizin (4.9 km²)
 }
 Hourly discharge observations of the six catchments are provided for one hydrological year, from 2013-10-01 to 2014-10-01. It has been extracted from the French HYDRO database (http://www.hydro.eaufrance.fr). Discharge observations for the Coët-Dan river is provided by the AgrHys Environment Research Observatories \insertCite{Fovet2018}{transfR} managed by INRAE (https://www6.inrae.fr/ore_agrhys_eng). Catchment delineations and respective maps of hydraulic length have been extracted from a digital elevation model of 100 m resolution.
 }
@@ -25,9 +25,9 @@ Hourly discharge observations of the six catchments are provided for one hydrolo
 
 \format{'Blavet' is a list of three objects:
 \itemize{
-  \item {hl}  {A list of stars objects containing the six rasters maps of hydraulic length.}
-  \item {obs}  {A stars object with two dimensions (time and space, with catchment delineations as spatial support) and one attribute (discharge observations).}
-  \item {network} {A sf object of the [French TOPAGE river network](https://bdtopage.eaufrance.fr/). It can be downloaded using the Web Feature Service (WFS) "Sandre - Eau France", as shown in the example below.}
+  \item hl: A list of stars objects containing the six rasters maps of hydraulic length.
+  \item obs: A stars object with two dimensions (time and space, with catchment delineations as spatial support) and one attribute (discharge observations).
+  \item network: A sf object of the [French TOPAGE river network](https://bdtopage.eaufrance.fr/). It can be downloaded using the Web Feature Service (WFS) "Sandre - Eau France", as shown in the example below.
 }}
 
 

man/Oudon.Rd

@@ -12,12 +12,12 @@
 \description{
 'Oudon' is a dataset of the Oudon French river, part of the wider Loire Catchment. It contains all the necessary inputs to test the package and perform discharge prediction at the outlet of six sub-catchments:
 \itemize{
-  \item {M3771810}  {Oudon at Châtelais (734 km²)}
-  \item {M3774010}  {Chéran at la Boissière (85 km²)}
-  \item {M3823010}  {Verzée at Bourg-d'Iré (205 km²)}
-  \item {M3834030}  {Argos at Sainte-Gemmes-d'Andigné (153 km²)}
-  \item {M3851810}  {Oudon at Segré (1310 km²)}
-  \item {M3711810}  {Oudon at Cossé-le-Vivien (133 km²)}
+  \item M3771810: Oudon at Châtelais (734 km²)
+  \item M3774010: Chéran at la Boissière (85 km²)
+  \item M3823010: Verzée at Bourg-d'Iré (205 km²)
+  \item M3834030: Argos at Sainte-Gemmes-d'Andigné (153 km²)
+  \item M3851810: Oudon at Segré (1310 km²)
+  \item M3711810: Oudon at Cossé-le-Vivien (133 km²)
 }
 Hourly discharge observations of the six sub-catchments (Oudon French river) are provided from 2019-12-01 to 2020-03-01, and extracted from the French HYDRO database (http://www.hydro.eaufrance.fr). Catchment delineations and respective maps of hydraulic length have been extracted from a digital elevation model of 100 m resolution.
 }
@@ -25,8 +25,8 @@ Hourly discharge observations of the six sub-catchments (Oudon French river) are
 
 \format{'Oudon' is a list of two objects:
 \itemize{
-  \item {hl}  {A list of stars objects containing the six rasters maps of hydraulic length.}
-  \item {obs}  {A stars object with two dimensions (time and space, with catchment delineations as spatial support) and one attribute (discharge observations).}
+  \item hl: A list of stars objects containing the six rasters maps of hydraulic length.
+  \item obs: A stars object with two dimensions (time and space, with catchment delineations as spatial support) and one attribute (discharge observations).
 }}
 
 

transfR.Rproj

 Version: 1.0
+ProjectId: c005be0b-f519-446f-af2c-824c2ca30cf0
 
 RestoreWorkspace: Default
 SaveWorkspace: Default