Commit e20cf54e authored by Dorchies David's avatar Dorchies David
Browse files

doc: remove pandoc superscripts for km2 and m3/s

Refs #43
parent a497ff23
......@@ -39,7 +39,7 @@ ConvertMeteoSD.character <- function(x, griwrm, meteo, ...) {
return(output)
}
#' @param areas [numeric] vector with the total area of the basin followed by the areas of the upstream basins in km^2^
#' @param areas [numeric] vector with the total area of the basin followed by the areas of the upstream basins in km2
#' @param temperature [logical] `TRUE` if the meteorological data contain air temperature. If `FALSE` minimum output values are bounded to zero
#' @export
#' @rdname ConvertMeteoSD
......
......@@ -5,7 +5,7 @@
#'
#' * a node identifier (column `id`),
#' * the identifier and the hydraulic distance to the downstream node ([character] columns `down` and [numeric] columns `length` in km). The last downstream node should have fields `down` and `length` set to `NA`,
#' * the area of the basin ([numeric] column `area` in km^2^)
#' * the area of the basin ([numeric] column `area` in km2)
#' * the hydrological model to use if necessary ([character] column `model`) ([NA] for using observed flow instead of a runoff model output)
#'
#' @param db [data.frame] description of the network (See details)
......@@ -16,7 +16,7 @@
#' * `id` ([character]): node identifier
#' * `down` ([character]): identifier of the node downstream of the current node ([NA] for the most downstream node)
#' * `length` ([numeric]): hydraulic distance to the downstream node in km ([NA] for the most downstream node)
#' * `area` ([numeric]): total area of the basin starting from the current node location in km^2^
#' * `area` ([numeric]): total area of the basin starting from the current node location in km2
#' * `model` ([character]): hydrological model to use if necessary ([NA] for using observed flow instead of a runoff model output)
#'
#' @aliases GRiwrm
......
......@@ -2,7 +2,7 @@
#'
#' @format a [list] with 2 items:
#'
#' - "BasinsInfo" which contains a [data.frame] with Gauging station identifier, name, coordinates (GPS), area (km^2^), mean elevation (m), station type, flow period start and end, the bank full flow (m^3^/s), the identifier of the following downstream station and the distance to the following downstream station
#' - "BasinsInfo" which contains a [data.frame] with Gauging station identifier, name, coordinates (GPS), area (km2), mean elevation (m), station type, flow period start and end, the bank full flow (m3/s), the identifier of the following downstream station and the distance to the following downstream station
#' - "BasinObs" which contains a [list] with an item by gauging station which contains a [data.frame] with [POSIXct] dates, precipitations (mm/time step), potential evapotranspiration (mm/time step) and measured flows (mm/time step)
#'
#' @source \url{https://doi.org/10.5285/8344E4F3-D2EA-44F5-8AFA-86D2987543A9}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment