documentation 📄

.Rbuildignore

@@ -2,3 +2,4 @@
 ^\.Rproj\.user$
 ^LICENSE\.md$
 ^data-raw$
+^README\.Rmd$

.gitignore

@@ -4,3 +4,4 @@
 .httr-oauth
 .DS_Store
 .quarto
+data-raw/gaas

DESCRIPTION

@@ -1,18 +1,23 @@
 Package: gaaScraper
-Title: What the Package Does (One Line, Title Case)
+Title: Scrapes Data from Brazilian Adoption Support Groups
 Version: 0.0.0.9000
-Authors@R: 
-    person("First", "Last", , "[email protected]", role = c("aut", "cre"),
-           comment = c(ORCID = "YOUR-ORCID-ID"))
-Description: What the package does (one paragraph).
+Authors@R:
+    c(person('Julio', 'Trecenti',
+             email = '[email protected]',
+             role = c('cre', 'aut'),
+             comment = c(ORCID = "0000-0002-1680-6389")),
+      person(given = "Associação Brasileira de Jurimetria",
+             role = c("cph", "fnd")))
+Description: Scrapes data from Brazilian adoption support groups. The data are
+    available at <https://www.angaad.org.br/portal/gaas/>.
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
-Depends: 
+Depends:
     R (>= 2.10)
 LazyData: true
-Imports: 
+Imports:
     dplyr,
     fs,
     httr,

NAMESPACE

@@ -1,2 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(gaa_download)
+export(gaa_estados)
+export(gaa_instituicoes)
+export(gaa_parse)

R/utils-data.R

@@ -0,0 +1,33 @@
+#' da_gaas
+#'
+#' Base de dados com informações sobre os Grupos de Apoio à Adoção (GAA) do Brasil.
+#'
+#' @format Um tibble com 202 rows e 23 variables:
+#' \describe{
+#'   \item{id}{Identificador único do GAA}
+#'   \item{link}{Link para o site do GAA}
+#'   \item{img_link}{Link para a imagem do GAA}
+#'   \item{title}{Nome do GAA}
+#'   \item{city}{Cidade do GAA}
+#'   \item{uf}{Estado do GAA}
+#'   \item{ibge}{Código IBGE da cidade do GAA}
+#'   \item{file}{Caminho do arquivo com o GAA}
+#'   \item{cep}{CEP do GAA}
+#'   \item{cnpj}{CNPJ do GAA}
+#'   \item{contato}{Nome do contato do GAA}
+#'   \item{data_de_fundacao}{Data de fundação do GAA}
+#'   \item{e_mail}{E-mail do GAA}
+#'   \item{endereco}{Endereço do GAA}
+#'   \item{facebook}{Facebook do GAA}
+#'   \item{instagram}{Instagram do GAA}
+#'   \item{nome}{Nome do GAA}
+#'   \item{reunioes}{Informações sobre as reuniões do GAA}
+#'   \item{sigla}{Sigla do GAA}
+#'   \item{site}{Site do GAA}
+#'   \item{telefone}{Telefone do GAA}
+#'   \item{youtube}{Youtube do GAA}
+#'   \item{txt_completo}{Texto completo do GAA}
+#' }
+#'
+#' @source <https://www.angaad.org.br/portal/gaas/>
+"da_gaas"

R/utils-global.R

@@ -0,0 +1,3 @@
+utils::globalVariables(c(
+  "key", "parse_item", "value"
+))

README.Rmd

@@ -0,0 +1,75 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# gaaScraper
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+O objetivo do pacote `gaaScraper` é facilitar a coleta de dados do site dos GAAs (Grupos de Apoio à Adoção) de todo o Brasil.
+
+## Instalação
+
+Você pode instalar a versão de desenvolvimento do `gaaScraper` do [GitHub](https://github.com/abjur/gaaScraper) com:
+
+```r
+# install.packages("remotes")
+remotes::install_github("abjur/gaaScraper")
+```
+
+## Dados
+
+A parte importante do pacote são os dados organizados:
+
+```r
+dplyr::glimpse(gaaScraper::da_gaas)
+```
+Rows: 202
+Columns: 23
+$ id               <int> 1, 42, 5, 11, 5, 7, 2, 12, 2, 10, 6, 7, 48, 10, 11, 5, 1, 1, 2, 4, …
+$ link             <chr> "https://www.angaad.org.br/portal/acalanto-rondonia/", "https://www…
+$ img_link         <chr> "https://www.angaad.org.br/portal/wp-content/uploads/2018/06/GAAS-D…
+$ title            <chr> "GAA Acalanto Rondônia", "GAA Acolher", "ADOTE E AME – Grupo de Apo…
+$ city             <chr> "Porto Velho", "São Paulo", "Duque de Caxias", "Rio das Ostras", "C…
+$ uf               <chr> "RO", "SP", "RJ", "RJ", "RS", "MS", "MT", "RJ", "BA", "RJ", "RJ", "…
+$ ibge             <chr> "1100205", "3550308", "3301702", "3304524", "4304630", "5007901", "…
+$ file             <chr> "data-raw/gaas/acalanto-rondonia.html", "data-raw/gaas/acolhersp.ht…
+$ cep              <chr> "76803-778", "04647-010", NA, "28893-076", "95555-000", NA, "78.058…
+$ cnpj             <chr> NA, "04.823.726/0001-85", NA, NA, NA, NA, "10.718.071/0001-88", NA,…
+$ contato          <chr> "Cristiane Zemuner", "Cecília Zelic", NA, "Dora", "Karina Meneghett…
+$ data_de_fundacao <chr> "14/05/2016", "13/05/1999", NA, "01/05/2007", NA, NA, "05/03/2009",…
+$ e_mail           <chr> "[email protected]", "[email protected]", NA, NA,…
+$ endereco         <chr> "R. Pio XII, 2240 – São João Bosco – Porto Velho/RO", "Rua Jacatirã…
+$ facebook         <chr> "Acalanto Rondônia", "Acolher Grupo de Apoio à Adoção", NA, "Facebo…
+$ instagram        <chr> NA, "@acolhergaad", NA, NA, "@adottaregrupodeapoio", NA, "@amparacu…
+$ nome             <chr> "Grupo de Apoio à Adoção Acalanto Rondônia", "Acolher Grupo de Apoi…
+$ reunioes         <chr> "Por enquanto somente whatsapp. Logo voltaremos com a reunião prese…
+$ sigla            <chr> "Acalanto Rondônia", "Acolher", NA, "ADOTE", "Adottare", "AFAGAS", …
+$ site             <chr> NA, "Acolher Grupo de Apoio à Adoção", NA, NA, NA, "www.afagas.org.…
+$ telefone         <chr> "(69) 99343 8606", "(11) 97682-3754", NA, NA, "(51) 98137-9365", "(…
+$ youtube          <chr> NA, "Acolher Grupo de Apoio à Adoção SP", NA, NA, NA, NA, NA, NA, "…
+$ txt_completo     <chr> "\n\t\t\t\r\n\t\t\t\t 1.845\r\n\t\t\tNOME: Grupo de Apoio à Adoção …
+```
+
+As informações id, link, img_link, title, city, uf, ibge, são extraídas da [página inicial do site](https://www.angaad.org.br/portal/gaas/). As demais informações são extraídas da página de cada GAA. O código IBGE é extraído utilizando-se o pacote [`munifacil`](https://github.com/curso-r/munifacil).
+
+As informações dos GAAS não são muito consistentes, já que a estrutura da página pode variar. Por isso, adicionamos uma coluna `txt_completo` com o texto completo da página, para que você possa fazer a extração de informações que não estão no pacote.
+
+A base bruta dos GAAS, em formato `.rds`, foram adicionados nos Releases do repositório. Os arquivos HTML também foram adicionados nos Releases.
+
+## Licença
+
+MIT
+

README.md

@@ -0,0 +1,78 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# gaaScraper
+
+<!-- badges: start -->
+
+<!-- badges: end -->
+
+O objetivo do pacote `gaaScraper` é facilitar a coleta de dados do site
+dos GAAs (Grupos de Apoio à Adoção) de todo o Brasil.
+
+## Instalação
+
+Você pode instalar a versão de desenvolvimento do `gaaScraper` do
+[GitHub](https://github.com/abjur/gaaScraper) com:
+
+``` r
+# install.packages("remotes")
+remotes::install_github("abjur/gaaScraper")
+```
+
+## Dados
+
+A parte importante do pacote são os dados organizados:
+
+``` r
+dplyr::glimpse(gaaScraper::da_gaas)
+```
+
+Rows: 202 Columns: 23 $ id <int> 1, 42, 5, 11, 5, 7, 2, 12, 2, 10, 6, 7,
+48, 10, 11, 5, 1, 1, 2, 4, … $ link <chr>
+“<https://www.angaad.org.br/portal/acalanto-rondonia/>”,
+“<https://www>… $ img\_link
+<chr>”<https://www.angaad.org.br/portal/wp-content/uploads/2018/06/GAAS-D>…
+$ title <chr> “GAA Acalanto Rondônia”, “GAA Acolher”, “ADOTE E AME –
+Grupo de Apo… $ city <chr>”Porto Velho“,”São Paulo“,”Duque de
+Caxias“,”Rio das Ostras“,”C… $ uf <chr> “RO”, “SP”, “RJ”, “RJ”,
+“RS”, “MS”, “MT”, “RJ”, “BA”, “RJ”, “RJ”, “… $ ibge
+<chr>”1100205“,”3550308“,”3301702“,”3304524“,”4304630“,”5007901“,”…
+$ file <chr> “data-raw/gaas/acalanto-rondonia.html”,
+“data-raw/gaas/acolhersp.ht… $ cep <chr>”76803-778“,”04647-010“,
+NA,”28893-076“,”95555-000“, NA,”78.058… $ cnpj <chr> NA,
+“04.823.726/0001-85”, NA, NA, NA, NA, “10.718.071/0001-88”, NA,… $
+contato <chr> “Cristiane Zemuner”, “Cecília Zelic”, NA, “Dora”, “Karina
+Meneghett… $ data\_de\_fundacao <chr>”14/05/2016“,”13/05/1999“,
+NA,”01/05/2007“, NA, NA,”05/03/2009“,… $ e\_mail
+<chr>”<[email protected]>“,”<[email protected]>“,
+NA, NA,… $ endereco <chr>”R. Pio XII, 2240 – São João Bosco – Porto
+Velho/RO“,”Rua Jacatirã… $ facebook <chr> “Acalanto Rondônia”, “Acolher
+Grupo de Apoio à Adoção”, NA, “Facebo… $ instagram <chr>
+NA,”@acolhergaad“, NA, NA,”@adottaregrupodeapoio“, NA,”@amparacu… $
+nome <chr> “Grupo de Apoio à Adoção Acalanto Rondônia”, “Acolher Grupo
+de Apoi… $ reunioes <chr>”Por enquanto somente whatsapp. Logo voltaremos
+com a reunião prese… $ sigla <chr> “Acalanto Rondônia”, “Acolher”, NA,
+“ADOTE”, “Adottare”, “AFAGAS”, … $ site <chr> NA, “Acolher Grupo de
+Apoio à Adoção”, NA, NA, NA, “www.afagas.org.… $ telefone <chr>”(69)
+99343 8606“,”(11) 97682-3754“, NA, NA,”(51) 98137-9365“,”(… $ youtube
+<chr> NA, “Acolher Grupo de Apoio à Adoção SP”, NA, NA, NA, NA, NA, NA,
+“… $ txt\_completo <chr>”.845: Grupo de Apoio à Adoção … \`\`\`
+
+As informações id, link, img\_link, title, city, uf, ibge, são extraídas
+da [página inicial do site](https://www.angaad.org.br/portal/gaas/). As
+demais informações são extraídas da página de cada GAA. O código IBGE é
+extraído utilizando-se o pacote
+[`munifacil`](https://github.com/curso-r/munifacil).
+
+As informações dos GAAS não são muito consistentes, já que a estrutura
+da página pode variar. Por isso, adicionamos uma coluna `txt_completo`
+com o texto completo da página, para que você possa fazer a extração de
+informações que não estão no pacote.
+
+A base bruta dos GAAS, em formato `.rds`, foram adicionados nos Releases
+do repositório. Os arquivos HTML também foram adicionados nos Releases.
+
+## Licença
+
+MIT