Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
IN-WOP
hubeau
Commits
a26c354f
Commit
a26c354f
authored
Aug 06, 2021
by
Dorchies David
Browse files
doc: comments in examples
parent
f62d4134
Changes
16
Hide whitespace changes
Inline
Side-by-side
R/get_hydrometrie_observations_tr.R
View file @
a26c354f
...
...
@@ -8,7 +8,7 @@
#' @export
#'
#' @examples
#' #
For r
etriev
ing
the hydrometric last real time observed discharge at station 'H020302002'
#' #
R
etriev
e
the hydrometric last real time observed discharge at station 'H020302002'
#' get_hydrometrie_observations_tr(list(code_entite = "H0203020", grandeur_hydro = "Q"))
#'
get_hydrometrie_observations_tr
<-
function
(
params
,
...
...
R/get_hydrometrie_sites.R
View file @
a26c354f
...
...
@@ -9,7 +9,7 @@
#' @export
#'
#' @examples
#' #
For r
etriev
ing
the hydrometric sites in the department of Aube
#' #
R
etriev
e
the hydrometric sites in the department of Aube
#' get_hydrometrie_sites(list(code_departement = "10"))
#'
#' # The same operation returning 2 rows for the site 'H0203020' which has 2 different locations
...
...
R/get_hydrometrie_stations.R
View file @
a26c354f
...
...
@@ -9,7 +9,7 @@
#' @export
#'
#' @examples
#' #
For r
etriev
ing
the hydrometric stations in the department of Aube
#' #
R
etriev
e
the hydrometric stations in the department of Aube
#' get_hydrometrie_stations(list(code_departement = "10"))
#'
get_hydrometrie_stations
<-
function
(
params
,
code_sandre_reseau_station
=
FALSE
,
cfg
=
config
::
get
(
file
=
system.file
(
"config.yml"
,
...
...
R/get_indicateurs_services_communes.R
View file @
a26c354f
...
...
@@ -15,7 +15,7 @@
#' @export
#'
#' @examples
#' #
For r
etriev
ing
performance indicator time series of the services in Romilly-sur-Seine
#' #
R
etriev
e
performance indicator time series of the services in Romilly-sur-Seine
#' get_indicateurs_services_communes(list(code_commune = "10323"))
#'
get_indicateurs_services_communes
<-
function
(
params
,
...
...
R/get_indicateurs_services_indicateurs.R
View file @
a26c354f
...
...
@@ -15,7 +15,7 @@
#' @export
#'
#' @examples
#' #
For r
etriev
ing
the withdrawal time series of the devices located in Romilly-sur-Seine
#' #
R
etriev
e
the withdrawal time series of the devices located in Romilly-sur-Seine
#' get_indicateurs_services_indicateurs(list(code_indicateur = "D102.0", annee = "2012"))
#'
get_indicateurs_services_indicateurs
<-
function
(
params
,
...
...
R/get_prelevements_chroniques.R
View file @
a26c354f
...
...
@@ -8,7 +8,7 @@
#' @export
#'
#' @examples
#' #
For r
etriev
ing
the withdrawal time series of the devices located in Romilly-sur-Seine
#' #
R
etriev
e
the withdrawal time series of the devices located in Romilly-sur-Seine
#' get_prelevements_chroniques(list(code_commune_insee = "10323"))
#'
get_prelevements_chroniques
<-
function
(
params
,
cfg
=
config
::
get
(
file
=
system.file
(
"config.yml"
,
...
...
R/get_prelevements_ouvrages.R
View file @
a26c354f
...
...
@@ -8,7 +8,7 @@
#' @export
#'
#' @examples
#' #
For r
etriev
ing
the withdrawal devices located in Romilly-sur-Seine
#' #
R
etriev
e
the withdrawal devices located in Romilly-sur-Seine
#' get_prelevements_ouvrages(list(code_commune_insee = "10323"))
#'
get_prelevements_ouvrages
<-
function
(
params
,
cfg
=
config
::
get
(
file
=
system.file
(
"config.yml"
,
...
...
R/get_prelevements_points_prelevement.R
View file @
a26c354f
...
...
@@ -8,7 +8,7 @@
#' @export
#'
#' @examples
#' #
For r
etriev
ing
the withdrawal points located in Romilly-sur-Seine
#' #
R
etriev
e
the withdrawal points located in Romilly-sur-Seine
#' get_prelevements_points_prelevement(list(code_commune_insee = "10323"))
#'
get_prelevements_points_prelevement
<-
function
(
params
,
cfg
=
config
::
get
(
file
=
system.file
(
"config.yml"
,
...
...
man/get_hydrometrie_observations_tr.Rd
View file @
a26c354f
...
...
@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
}
\examples{
#
For r
etriev
ing
the hydrometric last real time observed discharge at station 'H020302002'
#
R
etriev
e
the hydrometric last real time observed discharge at station 'H020302002'
get_hydrometrie_observations_tr(list(code_entite = "H0203020", grandeur_hydro = "Q"))
}
man/get_hydrometrie_sites.Rd
View file @
a26c354f
...
...
@@ -25,7 +25,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
}
\examples{
#
For r
etriev
ing
the hydrometric sites in the department of Aube
#
R
etriev
e
the hydrometric sites in the department of Aube
get_hydrometrie_sites(list(code_departement = "10"))
# The same operation returning 2 rows for the site 'H0203020' which has 2 different locations
...
...
man/get_hydrometrie_stations.Rd
View file @
a26c354f
...
...
@@ -25,7 +25,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
}
\examples{
#
For r
etriev
ing
the hydrometric stations in the department of Aube
#
R
etriev
e
the hydrometric stations in the department of Aube
get_hydrometrie_stations(list(code_departement = "10"))
}
man/get_indicateurs_services_communes.Rd
View file @
a26c354f
...
...
@@ -29,7 +29,7 @@ a \link[tibble:tibble]{tibble::tibble} with one row by commune, by service and b
See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
}
\examples{
#
For r
etriev
ing
performance indicator time series of the services in Romilly-sur-Seine
#
R
etriev
e
performance indicator time series of the services in Romilly-sur-Seine
get_indicateurs_services_communes(list(code_commune = "10323"))
}
man/get_indicateurs_services_indicateurs.Rd
View file @
a26c354f
...
...
@@ -29,7 +29,7 @@ a \link[tibble:tibble]{tibble::tibble} with one row by commune, by service and b
See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
}
\examples{
#
For r
etriev
ing
the withdrawal time series of the devices located in Romilly-sur-Seine
#
R
etriev
e
the withdrawal time series of the devices located in Romilly-sur-Seine
get_indicateurs_services_indicateurs(list(code_indicateur = "D102.0", annee = "2012"))
}
man/get_prelevements_chroniques.Rd
View file @
a26c354f
...
...
@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
}
\examples{
#
For r
etriev
ing
the withdrawal time series of the devices located in Romilly-sur-Seine
#
R
etriev
e
the withdrawal time series of the devices located in Romilly-sur-Seine
get_prelevements_chroniques(list(code_commune_insee = "10323"))
}
man/get_prelevements_ouvrages.Rd
View file @
a26c354f
...
...
@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
}
\examples{
#
For r
etriev
ing
the withdrawal devices located in Romilly-sur-Seine
#
R
etriev
e
the withdrawal devices located in Romilly-sur-Seine
get_prelevements_ouvrages(list(code_commune_insee = "10323"))
}
man/get_prelevements_points_prelevement.Rd
View file @
a26c354f
...
...
@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau#/prelevements/prelevement}
}
\examples{
#
For r
etriev
ing
the withdrawal points located in Romilly-sur-Seine
#
R
etriev
e
the withdrawal points located in Romilly-sur-Seine
get_prelevements_points_prelevement(list(code_commune_insee = "10323"))
}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment