diff --git a/R/doApiQuery.R b/R/doApiQuery.R index 1b691b6c50d352b2538413fc58b5f9398d2b2907..63eae6895b415d594159fc9755b0ad48bc1ee96c 100644 --- a/R/doApiQuery.R +++ b/R/doApiQuery.R @@ -9,7 +9,6 @@ #' #' @param api a [character] name of the API (e.g.: "indicateurs_services", "prelevements"...), see example for available APIs #' @param operation a [character] name of the operation, see example for available operations in an API -#' @param params a [list] the list of parameters of the queries and their values in the format `list(ParamName = "Param value", ...)`, use the function `get_available_params` for a list of the available parameters for a given operation in an API #' @template param_get_common #' #' @return A [list] with the concatenated results returned by the API. diff --git a/R/get_indicateurs_services_communes.R b/R/get_indicateurs_services_communes.R index 7a857ac18bd5262098280b9a877f8a7b3fba54e2..eb744a2c2de2f25fa6d0ecb79f2d7eb79a2c0a67 100644 --- a/R/get_indicateurs_services_communes.R +++ b/R/get_indicateurs_services_communes.R @@ -2,7 +2,6 @@ #' #' See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services} #' -#' @param params [list] where the keys are the names of the filtered parameters and the values are the values of the filters. See the API documentation for the complete list of available filter parameters #' @template param_get_common #' #' @return a [tibble::tibble] with one row by commune, by service and by year and the following columns: diff --git a/R/get_indicateurs_services_indicateurs.R b/R/get_indicateurs_services_indicateurs.R index 35a54f6fa770203d1187499958a83204db8fcd1f..b8497a0ab1f8252194e5931740e5e27e2055e982 100644 --- a/R/get_indicateurs_services_indicateurs.R +++ b/R/get_indicateurs_services_indicateurs.R @@ -2,7 +2,6 @@ #' #' See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services} #' -#' @param params [list] where the keys are the names of the filtered parameters and the values are the values of the filters. See the API documentation for the complete list of available filter parameters #' @template param_get_common #' #' @return a [tibble::tibble] with one row by commune, by service and by year and the following columns: diff --git a/R/get_prelevements_chroniques.R b/R/get_prelevements_chroniques.R index 227a4d0cd9b5fa95a7226e424791966d3d6a4ba4..69929d695aa39dc398f438f6c340d16140ccc615 100644 --- a/R/get_prelevements_chroniques.R +++ b/R/get_prelevements_chroniques.R @@ -2,7 +2,6 @@ #' #' See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau#/prelevements/chronique} #' -#' @param params [list] where the keys are the names of the filtered parameters and the values are the values of the filters. See the API documentation for the complete list of available filter parameters #' @template param_get_common #' #' @return a [tibble::tibble] with all available parameters in columns and one row by device, year and usage. diff --git a/R/get_prelevements_points_prelevement.R b/R/get_prelevements_points_prelevement.R index 694885011bcd71fdfe26d80fea719db49491438a..de077c746ef987e03d09ae122e1f0a02269e293f 100644 --- a/R/get_prelevements_points_prelevement.R +++ b/R/get_prelevements_points_prelevement.R @@ -2,7 +2,6 @@ #' #' See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau#/prelevements/prelevement} #' -#' @param params [list] where the keys are the names of the filtered parameters and the values are the values of the filters. See the API documentation for the complete list of available filter parameters #' @template param_get_common #' #' @return a [tibble::tibble] with all available parameters in columns and one row by device. diff --git a/man-roxygen/param_get_common.R b/man-roxygen/param_get_common.R index ecf131342898dfef8a667319b9e9bb0371d37c77..11421592a1c579553866f4491aff855d0daacf38 100644 --- a/man-roxygen/param_get_common.R +++ b/man-roxygen/param_get_common.R @@ -1,2 +1,3 @@ +#' @param params a [list] the list of parameters of the queries and their values in the format `list(ParamName = "Param value", ...)`, use the function [get_available_params] for a list of the available parameters for a given operation in an API and see the API documentation for the complete list of available filter parameters #' @param cfg a [config] object Configuration of the communication. Use by default the internal package #' configuration diff --git a/man/doApiQuery.Rd b/man/doApiQuery.Rd index ee6c9e95989d922f908be0d960683e7ba9f42aec..261a27f01043d8824ea7eb596bc8e3970ec87200 100644 --- a/man/doApiQuery.Rd +++ b/man/doApiQuery.Rd @@ -23,7 +23,7 @@ get_available_params( \item{operation}{a \link{character} name of the operation, see example for available operations in an API} -\item{params}{a \link{list} the list of parameters of the queries and their values in the format \code{list(ParamName = "Param value", ...)}, use the function \code{get_available_params} for a list of the available parameters for a given operation in an API} +\item{params}{a \link{list} the list of parameters of the queries and their values in the format \code{list(ParamName = "Param value", ...)}, use the function \link{get_available_params} for a list of the available parameters for a given operation in an API and see the API documentation for the complete list of available filter parameters} \item{cfg}{a \link{config} object Configuration of the communication. Use by default the internal package configuration} diff --git a/man/get_indicateurs_services_communes.Rd b/man/get_indicateurs_services_communes.Rd index d5d1002bda4c9b1f83f59d5bffca3f44c6491eff..6f2e463655c7c9f1f2257f63901b85d4edd4f440 100644 --- a/man/get_indicateurs_services_communes.Rd +++ b/man/get_indicateurs_services_communes.Rd @@ -10,7 +10,7 @@ get_indicateurs_services_communes( ) } \arguments{ -\item{params}{\link{list} where the keys are the names of the filtered parameters and the values are the values of the filters. See the API documentation for the complete list of available filter parameters} +\item{params}{a \link{list} the list of parameters of the queries and their values in the format \code{list(ParamName = "Param value", ...)}, use the function \link{get_available_params} for a list of the available parameters for a given operation in an API and see the API documentation for the complete list of available filter parameters} \item{cfg}{a \link{config} object Configuration of the communication. Use by default the internal package configuration} diff --git a/man/get_indicateurs_services_indicateurs.Rd b/man/get_indicateurs_services_indicateurs.Rd index a3157ee456cca8fbc266b71e201fc7f1e4eb41e0..1c03ef9da0342097353a3ca08a828e5fda96e41c 100644 --- a/man/get_indicateurs_services_indicateurs.Rd +++ b/man/get_indicateurs_services_indicateurs.Rd @@ -10,7 +10,7 @@ get_indicateurs_services_indicateurs( ) } \arguments{ -\item{params}{\link{list} where the keys are the names of the filtered parameters and the values are the values of the filters. See the API documentation for the complete list of available filter parameters} +\item{params}{a \link{list} the list of parameters of the queries and their values in the format \code{list(ParamName = "Param value", ...)}, use the function \link{get_available_params} for a list of the available parameters for a given operation in an API and see the API documentation for the complete list of available filter parameters} \item{cfg}{a \link{config} object Configuration of the communication. Use by default the internal package configuration} diff --git a/man/get_prelevements_chroniques.Rd b/man/get_prelevements_chroniques.Rd index 6a1071d86fd288e621df9c24689a9d41aed31011..9d76894d07141533f7991f1def7cb60c707edbec 100644 --- a/man/get_prelevements_chroniques.Rd +++ b/man/get_prelevements_chroniques.Rd @@ -10,7 +10,7 @@ get_prelevements_chroniques( ) } \arguments{ -\item{params}{\link{list} where the keys are the names of the filtered parameters and the values are the values of the filters. See the API documentation for the complete list of available filter parameters} +\item{params}{a \link{list} the list of parameters of the queries and their values in the format \code{list(ParamName = "Param value", ...)}, use the function \link{get_available_params} for a list of the available parameters for a given operation in an API and see the API documentation for the complete list of available filter parameters} \item{cfg}{a \link{config} object Configuration of the communication. Use by default the internal package configuration} diff --git a/man/get_prelevements_points_prelevement.Rd b/man/get_prelevements_points_prelevement.Rd index e158909c2879db5aae22588c0f84601e92b9e838..fbb2846e4568395829b8f500034cd7ca23084556 100644 --- a/man/get_prelevements_points_prelevement.Rd +++ b/man/get_prelevements_points_prelevement.Rd @@ -10,7 +10,7 @@ get_prelevements_points_prelevement( ) } \arguments{ -\item{params}{\link{list} where the keys are the names of the filtered parameters and the values are the values of the filters. See the API documentation for the complete list of available filter parameters} +\item{params}{a \link{list} the list of parameters of the queries and their values in the format \code{list(ParamName = "Param value", ...)}, use the function \link{get_available_params} for a list of the available parameters for a given operation in an API and see the API documentation for the complete list of available filter parameters} \item{cfg}{a \link{config} object Configuration of the communication. Use by default the internal package configuration}