Propuesta de mejoras en la documentación

.github/workflows/pkgdown.yaml

@@ -32,7 +32,7 @@ jobs:
 
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: any::pkgdown, local::.
+          extra-packages: any::pkgdown, local::., ropenspain/rostemplate
           needs: website
 
       - name: Build site

DESCRIPTION

@@ -4,7 +4,7 @@ Title: Download Data From 2021 Spanish Census
 Version: 0.1.0
 Author: Héctor Meleiro
 Maintainer: Héctor Meleiro <[email protected]>
-Description: Retrieves data from the 2021 Spanish census through the National Institute of Statistics official API. For more info on the available tables and variables visit https://www.ine.es/dyngs/DataLab/en/manual.html?cid=1259945952385.
+Description: Retrieves data from the 2021 Spanish census through the National Institute of Statistics official API. For more info on the available tables and variables visit <https://www.ine.es/dyngs/DataLab/en/manual.html?cid=1259945952385>.
 License: GPL (>= 3)
 Encoding: UTF-8
 LazyData: true
@@ -23,4 +23,6 @@ Suggests:
     tidygraph,
     scales
 VignetteBuilder: knitr
-URL: https://hmeleiro.github.io/tidycenso/
+URL: https://ropenspain.github.io/tidycenso/, https://github.com/rOpenSpain/tidycenso
+BugReports: https://github.com/ropenspain/tidycenso/issues
+Roxygen: list(markdown = TRUE)

R/get_censo.R

@@ -1,6 +1,6 @@
 #' Get data from the 2021 Spanish census
 #'
-#' `get_censo` retrieves data from the 2021 Spanish census through the API of the National Institute of Statistics. For more info on the available tables and variables visit https://www.ine.es/dyngs/DataLab/en/manual.html?cid=1259945952385.
+#' `get_censo` retrieves data from the 2021 Spanish census through the API of the National Institute of Statistics. For more info on the available tables and variables visit <https://www.ine.es/dyngs/DataLab/en/manual.html?cid=1259945952385>.
 #'
 #' @param table  A string of length 1 with the table name to query data from.
 #' @param variables A string with variable names of the queried table. If more than one, must be provided using c() (max. 4)

R/tidycenso-package.R

@@ -0,0 +1,6 @@
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+## usethis namespace: end
+NULL

README.Rmd

@@ -17,8 +17,8 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 
-[![R-CMD-check](https://github.com/hmeleiro/tidycenso/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/hmeleiro/tidycenso/actions/workflows/R-CMD-check.yaml) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
-
+[![R-CMD-check](https://github.com/rOpenSpain/tidycenso/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rOpenSpain/tidycenso/actions/workflows/R-CMD-check.yaml) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![rOS-badge](https://ropenspain.github.io/rostemplate/reference/figures/ropenspain-badge.svg)](https://ropenspain.es/)
 <!-- badges: end -->
 
 ## Overview

README.md

@@ -3,10 +3,10 @@
 
 <!-- badges: start -->
 
-[![R-CMD-check](https://github.com/hmeleiro/tidycenso/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/hmeleiro/tidycenso/actions/workflows/R-CMD-check.yaml)
+[![R-CMD-check](https://github.com/rOpenSpain/tidycenso/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rOpenSpain/tidycenso/actions/workflows/R-CMD-check.yaml)
 [![License: GPL
 v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
-
+[![rOS-badge](https://ropenspain.github.io/rostemplate/reference/figures/ropenspain-badge.svg)](https://ropenspain.es/)
 <!-- badges: end -->
 
 ## Overview
@@ -44,9 +44,9 @@ head(df)
 #> 1    25464               Andalucía Hasta 30 m2
 #> 2     2586                  Aragón Hasta 30 m2
 #> 3     3255 Asturias, Principado de Hasta 30 m2
-#> 4     7683          Balears, Illes Hasta 30 m2
+#> 4     7686          Balears, Illes Hasta 30 m2
 #> 5    11766                Canarias Hasta 30 m2
-#> 6     1008               Cantabria Hasta 30 m2
+#> 6     1005               Cantabria Hasta 30 m2
 
 tidycenso::tables
 #>   id_tabla                                 descripcion_tabla_es

_pkgdown.yml

@@ -1,4 +1,32 @@
-url: https://hmeleiro.github.io/tidycenso/
+url: https://ropenspain.github.io/tidycenso/
 template:
-  bootstrap: 5
+  package: rostemplate
+lang: en
+navbar:
+  structure:
+    left:  [intro, reference, articles]
+    right: [github, twitter, search]
+  components:
+    github:
+      icon: fa-github
+      href: https://github.com/rOpenSpain/tidycenso
+      aria-label: Github
+    twitter:
+      icon: fa-twitter
+      href: http://twitter.com/hmeleiros
+      aria-label: Twitter
+repo:
+  url:
+    home: https://github.com/rOpenSpain/tidycenso
+    issue: https://github.com/rOpenSpain/tidycenso/issues/
+    user: https://github.com/hmeleiro/
 
+home:
+  links:
+    - text: Report a bug
+      href: https://github.com/rOpenSpain/infoelectoral/issues
+  sidebar:
+    structure: [links, license, authors, citation, dev]
+authors:
+  Héctor Meleiro:
+    href: 'https://hmeleiro.com/'

vignettes/example-usage.Rmd

@@ -2,7 +2,7 @@
 title: "Use case: migration flows"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{Example}
+  %\VignetteIndexEntry{Use case: migration flows}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---
@@ -14,7 +14,7 @@ knitr::opts_chunk$set(
 )
 ```
 
-In this use case we show how to use [`tidycensus`](https://github.com/hmeleiro/tidycenso) to visualize the most important internal migration flows over the last 10 years.
+In this use case we show how to use [`tidycenso`](https://github.com/rOpenSpain/tidycenso) to visualize the most important internal migration flows over the last 10 years.
 
 First download the number of people by province of residence in 2011 and 2020.