rostemplate: Plantilla Para Sitios 'pkgdown' De Paquetes De 'rOpenSpain'

website·Indexed 29 days ago

https://ropenspain.github.io/mapSpain/index.html

An R package providing a customized pkgdown template for rOpenSpain package websites. It includes utilities for building sites locally, automating deployment via GitHub Actions to gh-pages or /docs, and adding rOpenSpain-specific elements like badges and color palettes.

Tokens
31.4K
Snippets
154
Records
252
Agent score
74%

What's inside rostemplate

  1. Overview of mapSpain capabilities

    mapSpain provides administrative boundaries and static map tiles for Spain. It offers sf objects for Autonomous Communities and Cities, provinces, municipalities, and NUTS levels, as well as grid maps and complementary geometries (e.g., Canary Islands inset boxes). It also includes a dictionary for translating subdivision names between English, Spanish, Catalan, Basque, and Galician, and converting between NUTS, ISO2, and INE codes.
  2. Overview of mapSpain R package

    mapSpain is an R package providing political and administrative boundaries of Spain at multiple levels. It supports static map tiles from WMS and WMTS services (as georeferenced rasters or leaflet layers) and includes helper functions to translate and convert Spanish subdivision names and codes. Most functions return sf objects or SpatRaster objects from the terra package. Data is sourced from GISCO (via giscoR), CartoBase ANE (IGN), and various Spanish public institutions.
  3. Overview of mapSpain documentation and resources

    The mapSpain package provides tools for creating maps of Spain in R, including administrative boundaries and map tiles. Documentation is available through practical guides for working with map imagery and Spanish region codes, as well as presentation materials from the Grupo de Usuarios R Madrid session.
  4. Overview of the mapSpain R package

    The mapSpain package provides administrative boundaries of Spain at multiple levels, including Autonomous Communities and Cities, provinces, municipalities, and 'NUTS'. The data is sourced from Eurostat's 'GISCO' and the Instituto Geográfico Nacional's 'CartoBase ANE'. Additionally, the package includes tools for downloading and processing static map tiles and a leaflet plugin specifically for Spanish public administration tile providers.
  5. Use Quarto vignettes with pkgdown

    pkgdown uses Quarto to generate HTML for vignettes but applies its own CSS and JS. Because of this, new Quarto features may not be immediately supported. pkgdown assumes the use of Quarto vignette style or an HTML format with minimal: true. Currently, only HTML vignettes are supported.
  6. Add GPL license notices to interactive program output

    For programs with terminal interaction, a short notice should be displayed when the program starts in interactive mode. This notice should inform the user that the software is free and provide commands (or a GUI 'about box') to view the full warranty and license details.
    mapSpain Copyright (C) 2020 Diego Hernangómez
    This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type 'show c' for details.
  7. Use the esp_nuts_2024 dataset for Spanish NUTS boundaries

    The esp_nuts_2024 dataset provides Spanish subdivisions at NUTS levels 0, 1, 2, and 3 based on the 2024 Nomenclature of Territorial Units for Statistics. It is provided as an sf object with MULTIPOLYGON geometries at 1:1 million resolution using the EPSG:4258 projection (ETRS89).
    data("esp_nuts_2024")
    head(esp_nuts_2024)
  8. Track rOpenSpain package downloads via CRAN and Posit Package Manager

    rOpenSpain package download statistics and metadata are tracked and available through two primary sources: CRAN and the Posit Package Manager. This data includes download history and weekly download trends.
  9. Understand the GNU General Public License v3 (GPLv3) terms

    The GNU General Public License version 3 is a copyleft license designed to guarantee the freedom to share and change software. Key principles include:

    • Freedom to Distribute: Users may distribute copies of the software (gratis or for a fee).
    • Source Code Access: Recipients must be able to receive the source code.
    • Preservation of Rights: If you distribute or modify the software, you must pass the same freedoms to the recipients and provide the license terms.
    • No Warranty: The license explicitly states there is no warranty for the software.
    • Anti-Circumvention: The license prohibits practices that deny users the ability to install or run modified versions of the software on devices.
  10. Reference for ros_badge_ropenspain()

    The ros_badge_ropenspain function is used to manage the rOpenSpain identity badge in project documentation.

    Arguments:

    • install (logical): If TRUE, the badge is written directly to README.md or README.Rmd. If FALSE, the function prints the Markdown snippet to the console.

    Return Value: The function is called for its side effects. When install = FALSE, it outputs the Markdown code for the badge.

  11. Fix typos in mapSpain documentation

    Typos, spelling mistakes, or grammatical errors in the documentation can be fixed directly via the GitHub web interface. Changes must be made in the source file (typically roxygen2 comments in an .R file) rather than the generated .Rd file. The source .R file can be identified by checking the comment on the first line of the .Rd file.