documentação de listar_campos

R/listar_campos.R

@@ -5,16 +5,23 @@
 #' são obrigatórios.
 
 #' @param estado Uma string. O nome da coluna que representa o estado do
-#'   endereço. Campo obrigatório.
+#'   endereço. Campo obrigatório. Na tabela de endereços, essa coluna pode
+#'   conter os nomes dos estados por extenso, ou a abrevição oficial dos estados
+#'   com duas letras, e.g. "AM", "SP", "DF", "RJ".
 #' @param municipio Uma string. O nome da coluna que representa o município do
-#'   endereço. Campo obrigatório.
+#'   endereço. Campo obrigatório. Na tabela de endereços, essa coluna pode
+#'   conter o nome dos municípios, ou o seu código IBGE de 7 dígitos.
 #' @param logradouro Uma string. O nome da coluna que representa o *logradouro*
 #'   (endereço da rua) do endereço. Pode ser `NULL` se o campo não estiver
-#'   especificado na tabela de endereços. O campo de `logradouro` *não* deve
-#'   incluir o `numero` do endereço, pois o número deve ser indicado numa coluna
-#'   separada.
+#'   especificado na tabela de endereços. Na tabela de endereços, essa coluna
+#'   deve incluir o *tipo* do lograoduro, indicando se trata-se de uma "Rua" ou
+#'   "Avenida" etc, por exemplo "Avenida Presidente Getúlio Vargas". Além disso,
+#'   essa coluna *não* deve incluir o `numero` do endereço, pois o número deve
+#'   ser indicado numa coluna separada.
 #' @param numero Uma string. O nome da coluna que representa o número do endereço.
 #'    Pode ser `NULL` se o campo não estiver especificado na tabela de endereços.
+#'    Na tabela de endereços, valores como `0` ou caracteres não numerciso como
+#'    `"S/N"` ou `"10a"` são considerados como `NA`.
 #' @param cep Uma string. O nome da coluna que representa o *CEP* (Código de
 #'    Endereçamento Postal) do endereço. Pode ser `NULL` se o campo não estiver
 #'    especificado na tabela de endereços.

man/roxygen/templates/precision_section.R

@@ -85,4 +85,4 @@
 #' correspondência probabilística do campo logradouro, enquanto os tipos que
 #' começam com 'e' utilizam apenas correspondência determinística. **As
 #' categorias de `tipo_resultado` que usam correspondência probabilística ainda
-#' não estão implementadas no {geocodebr}**.
+#' não estão implementadas no pacote geocodebr**.

vignettes/geocodebr.Rmd

@@ -196,8 +196,10 @@ As categorias de `tipo_resultado` são listadas abaixo, junto às categorias de
 - precisao `"municipio"`
   - `em01` - municipio
 
-Endereços não encontrados são retornados com latitude, longitude, precisão e
-tipo de resultado `NA`.
+Endereços não encontrados são retornados com latitude, longitude, precisão e tipo de resultado `NA`.
+
+
+***Nota:*** As categorias de `tipo_resultado` que começam com 'p' utilizam correspondência probabilística do campo logradouro, enquanto os tipos que começam com 'e' utilizam apenas correspondência determinística. **As categorias de `tipo_resultado` que usam correspondência probabilística ainda não estão implementados no pacote geocodebr**.
 
 ### Cache de dados
 

vignettes/geocoding_pt.Rmd

@@ -133,7 +133,7 @@ A lista completa dos níveis de precisão (`precisao`), suas categorias de tipo
   - tipo_resultado:
     - em01: municipio
 
-***Nota:*** As categorias de `match_type` que começam com 'p' utilizam correspondência probabilística do campo logradouro, enquanto os tipos que começam com 'e' utilizam apenas correspondência determinística. **As categorias de `match_type` que usam correspondência probabilística ainda não estão implementados no {geocodebr}**.
+***Nota:*** As categorias de `tipo_resultado` que começam com 'p' utilizam correspondência probabilística do campo logradouro, enquanto os tipos que começam com 'e' utilizam apenas correspondência determinística. **As categorias de `tipo_resultado` que usam correspondência probabilística ainda não estão implementados no pacote geocodebr**.
 
 
 # Cache de Dados