diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index d1b96b9..ee18a32 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -3,5 +3,5 @@ pkgdown: 2.0.9 pkgdown_sha: ~ articles: enderecopadrao: enderecopadrao.html -last_built: 2024-05-17T13:29Z +last_built: 2024-05-17T20:11Z diff --git a/dev/reference/correspondencia_logradouro.html b/dev/reference/correspondencia_logradouro.html index 3865a63..f8edfcc 100644 --- a/dev/reference/correspondencia_logradouro.html +++ b/dev/reference/correspondencia_logradouro.html @@ -1,6 +1,6 @@ -Correspondência entre os campos de logradouro e tipo de logradouro e suas colunas — correspondencia_logradouro • enderecopadraoCorrespondência entre os campos do logradouro completo e as colunas que os descrevem — correspondencia_logradouro • enderecopadrao @@ -47,18 +47,18 @@
-

Correspondência entre os campos de logradouro e tipo de logradouro e suas colunas

+

Correspondência entre os campos do logradouro completo e as colunas que os descrevem

Source: R/correspondencia_logradouro.R

Cria um vetor de caracteres que especifica as colunas que representam os -campos de logradouro e tipo de logradouro em um dataframe.

+campos de logradouro (tipo, nome e número) em um dataframe de endereços.

- 
correspondencia_logradouro(tipo_de_logradouro, logradouro)
+ 
correspondencia_logradouro(tipo_de_logradouro, logradouro, numero)
@@ -69,29 +69,32 @@

Arguments

logradouro
-

O nome da coluna que representa o logradouro no dataframe -de endereços.

+

O nome da coluna que representa o nome do logradouro no +dataframe de endereços.

+ + +
numero
+

O nome da coluna que representa o numero do logradouro no +dataframe de endereços.

Value

-

Um vetor nomeado de caracteres, cujos nomes são tipo_de_logradouro

- - -

e logradouro e os valores as respectivas colunas que os descrevem no -dataframe de endereços.

+

Um vetor nomeado de caracteres, em que os nomes representam os campos +do logradouro e os valores as colunas que os descrevem no dataframe.

Examples

correspondencia_logradouro(
   tipo_de_logradouro = "tipo_de_logradouro",
-  logradouro = "logradouro"
+  logradouro = "logradouro",
+  numero = "numero"
 )
-#>   tipo_de_logradouro           logradouro 
-#> "tipo_de_logradouro"         "logradouro" 
+#>   tipo_de_logradouro           logradouro               numero 
+#> "tipo_de_logradouro"         "logradouro"             "numero"
diff --git a/dev/reference/index.html b/dev/reference/index.html index 4eca710..cbfdb45 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -58,9 +58,9 @@

Padronização de múlt

Padronizar endereços

-

padronizar_logradouros_com_tipo()

+

padronizar_logradouros_completos()

-

Padronizar logradouros e tipos de logradouro simultaneamente

+

Padronizar logradouros completos

Padronização de campos individuais

@@ -108,7 +108,7 @@

Funções auxiliares

correspondencia_logradouro()

-

Correspondência entre os campos de logradouro e tipo de logradouro e suas colunas

+

Correspondência entre os campos do logradouro completo e as colunas que os descrevem

Tabelas de códigos

diff --git a/dev/reference/padronizar_logradouros_com_tipo.html b/dev/reference/padronizar_logradouros_completos.html similarity index 55% rename from dev/reference/padronizar_logradouros_com_tipo.html rename to dev/reference/padronizar_logradouros_completos.html index f369003..6c2bfe1 100644 --- a/dev/reference/padronizar_logradouros_com_tipo.html +++ b/dev/reference/padronizar_logradouros_completos.html @@ -1,7 +1,7 @@ -Padronizar logradouros e tipos de logradouro simultaneamente — padronizar_logradouros_com_tipo • enderecopadraoPadronizar logradouros completos — padronizar_logradouros_completos • enderecopadrao @@ -48,19 +48,19 @@
-

Padronizar logradouros e tipos de logradouro simultaneamente

- Source: R/padronizar_logradouros_com_tipo.R - +

Padronizar logradouros completos

+ Source: R/padronizar_logradouros_completos.R +
-

Padroniza o logradouro e seu tipo (dois campos diferentes) de forma -simultânea, produzindo um novo campo (logradouro_com_tipo) que garante a -consistência dos dados.

+

Padroniza o logradouro completo a partir de diversos campos (tipo de +logradouro, nome do logradouro e número), garantindo a consistência da +informação.

- 
padronizar_logradouros_com_tipo(
+    
padronizar_logradouros_completos(
   enderecos,
   campos_do_logradouro = correspondencia_logradouro(),
   manter_cols_extras = TRUE
@@ -70,8 +70,8 @@ 
Padronizar logradouros e tipos de logradouro simultaneamente

     

     
Arguments

     
enderecos

-
Um dataframe. Os endereços a serem padronizados, deve
-incluir uma coluna com o tipo de logradouro e outra com o logradouro em si.

+
Um dataframe. Os endereços a serem padronizados. Ao menos
+uma de suas colunas deve corresponder a um campo do logradouro.

 
 
 
campos_do_logradouro

@@ -80,15 +80,15 @@ 
Arguments

 representam no dataframe (valores em si). a função
 correspondencia_logradouro() facilita a criação deste vetor, fazendo
 também algumas verificações do conteúdo imputado. caso deseje criar o vetor
-manualmente, note que seus nomes devem ser logradouros e
-tipos_de_logradouro.

+manualmente, note que seus nomes devem ser os mesmos nomes dos parâmetros
+da função correspondencia_logradouro().

 
 
 
manter_cols_extras

 
Um logical. Se colunas não especificadas em
 campos_do_logradouro devem ser mantidas no output ou não (por exemplo,
-uma coluna com a informação de bairro ou de id do conjunto de dados sendo
-padronizado). Por padrão, TRUE.

+uma coluna com a informação de bairro ou com o id do conjunto de dados
+sendo padronizado). Por padrão, TRUE.

 
 

     

@@ -96,17 +96,16 @@ 
Value

     
 
 
Caso manter_cols_extras seja TRUE, o mesmo dataframe de input,
-mas sem as colunas descrevendo o logradouro e o tipo de logradouro e com
-uma coluna padronizada adicional logradouro_com_tipo. Caso
-manter_cols_extras seja FALSE, um dataframe de apenas uma coluna,
-logradouro_com_tipo.

+mas sem as colunas descrevendo o logradouro e com uma coluna padronizada
+adicional logradouro_completo. Caso manter_cols_extras seja FALSE, um
+dataframe de apenas uma coluna, logradouro_completo.

     

 
     

     
Examples

     
enderecos <- data.frame(
   id = 1,
-  tipo_logradouro = "r",
+  tipoLogradouro = "r",
   logradouro = "ns sra da piedade",
   nroLogradouro = 20,
   complemento = "qd 20",
@@ -117,26 +116,27 @@ 
Examples

 )
 
 campos <- correspondencia_logradouro(
-  tipo_de_logradouro = "tipo_logradouro",
-  logradouro = "logradouro"
+  tipo_de_logradouro = "tipoLogradouro",
+  logradouro = "logradouro",
+  numero = "nroLogradouro"
 )
 
-padronizar_logradouros_com_tipo(enderecos, campos)
-#>       id nroLogradouro complemento      cep      bairro codmun_dom uf_dom
-#>    <num>         <num>      <char>    <num>      <char>      <num> <char>
-#> 1:     1            20       qd 20 25220020 jd botanico    3304557     rj
-#>    .tmp_tipo_padrao          .tmp_log_padrao
-#>              <char>                   <char>
-#> 1:              RUA NOSSA SENHORA DA PIEDADE
+padronizar_logradouros_completos(enderecos, campos)
+#>       id complemento      cep      bairro codmun_dom uf_dom
+#>    <num>      <char>    <num>      <char>      <num> <char>
+#> 1:     1       qd 20 25220020 jd botanico    3304557     rj
+#>                logradouro_completo
+#>                             <char>
+#> 1: RUA NOSSA SENHORA DA PIEDADE 20
 
-padronizar_logradouros_com_tipo(
+padronizar_logradouros_completos(
   enderecos,
   campos,
   manter_cols_extras = FALSE
 )
-#>    .tmp_tipo_padrao          .tmp_log_padrao
-#>              <char>                   <char>
-#> 1:              RUA NOSSA SENHORA DA PIEDADE
+#>                logradouro_completo
+#>                             <char>
+#> 1: RUA NOSSA SENHORA DA PIEDADE 20
 
 

     

diff --git a/dev/sitemap.xml b/dev/sitemap.xml
index 74faabb..02622b1 100644
--- a/dev/sitemap.xml
+++ b/dev/sitemap.xml
@@ -58,7 +58,7 @@
     /reference/padronizar_logradouros.html
   
   
-    /reference/padronizar_logradouros_com_tipo.html
+    /reference/padronizar_logradouros_completos.html
   
   
     /reference/padronizar_municipios.html