Commit 98dc44f4 authored by Dorchies David's avatar Dorchies David
Browse files

doc(doQuery): correction and cleaning

parent 17540585
#' Internal function for doing the queries
#' Internal function for doing the queries for the bnpe package
#'
#' @param url_path the end of the URL path
#' @param params A list containing the parameters sent in the query. [character] Name of the geographical identifier ("insee_com", "code_dep"...)
#' @param params A list containing the parameters sent in the query
#' @inheritParams getCookie
#' @param cookie a named [character] [vector] with the values of the cookies (See [getCookie])
#'
......
#' @param cookie a named [character] [vector] with the values of the cookies (See [getCookie])
#' @inheritParams getCookie
......@@ -2,7 +2,7 @@
% Please edit documentation in R/doQuery.R
\name{doQuery}
\alias{doQuery}
\title{Internal function for doing the queries}
\title{Internal function for doing the queries for the bnpe package}
\usage{
doQuery(
url_path,
......@@ -15,7 +15,7 @@ doQuery(
\arguments{
\item{url_path}{the end of the URL path}
\item{params}{A list containing the parameters sent in the query. \link{character} Name of the geographical identifier ("insee_com", "code_dep"...)}
\item{params}{A list containing the parameters sent in the query}
\item{cfg}{a \link{config} object Configuration of the communication. Use by default the internal package
configuration stored at location \code{system.file("config.yml", package = "bnpe")}}
......@@ -26,5 +26,5 @@ configuration stored at location \code{system.file("config.yml", package = "bnpe
a \link[httr:response]{httr::response} object from a \link[httr:GET]{httr::GET}
}
\description{
Internal function for doing the queries
Internal function for doing the queries for the bnpe package
}
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