Add rogtemplate support

Author: dieghernan

.Rbuildignore

@@ -41,3 +41,5 @@ TROUBLESHOOTING.md
 ^\.github$
 ^doc$
 ^Meta$
+^pkgdown$
+^\._pkgdown\.yml$

.github/.gitignore

@@ -1 +1,3 @@
 *.html
+R-version
+*.Rds

.github/workflows/rogtemplate-gh-pages.yaml

@@ -0,0 +1,52 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+    tags: ['*']
+  workflow_dispatch:
+
+name: rogtemplate-gh-pages
+
+jobs:
+  rogtemplate-gh-pages:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-pandoc@v1
+
+      - uses: r-lib/actions/setup-r@v1
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v1
+        with:
+          extra-packages: |
+            magick
+            ropengov/rogtemplate
+
+          needs: website
+
+      - name: Build logo if not present and prepare template
+        run: |
+          # Check that logo is not present
+          if (isFALSE(file.exists(file.path("man", "figures", "logo.png")) ||
+            file.exists(file.path("man", "figures", "logo.png")))) {
+            rogtemplate::rog_logo()
+          } else {
+
+            message("The package already has a logo")
+          }
+
+          rogtemplate::rog_add_template_pkgdown()
+
+        shell: Rscript {0}
+
+      - name: Deploy package
+        run: |
+          git config --local user.name "$GITHUB_ACTOR"
+          git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com"
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'

DESCRIPTION

@@ -1,42 +1,49 @@
-Package: pxweb
 Type: Package
+Package: pxweb
 Title: R Interface to PXWEB APIs
 Version: 0.12.0
 Date: 2021-10-09
-Encoding: UTF-8
 Authors@R: c(
-  person("Mans", "Magnusson", email = "mons.magnusson@gmail.com", role = c("aut", "cre")),
-	person("Markus", "Kainu", role = "aut"),
-	person("Janne", "Huovari", role = "aut"),  	
-	person("Leo", "Lahti", role = "aut", comment = c(ORCID = "0000-0001-5537-637X")),
-	person("Love" , "Hansson", role = "ctb"),	
-	person("Eydun", "Nielsen", role = "ctb"),
-	person("Bo", "Werth", role = "ctb"),
-	person("Thomas", "Runarsson", role = "ctb"),
-	person("Torbjörn", "Lindquist", role = "ctb"),
-	person("Palmar", "Thorsteinsson", role = "ctb"),
-	person("Pyry", "Kantanen", role = "ctb"),
-	person("Sebastian", "Ankargren", role = "ctb"))
-Description: Generic interface for the PX-Web/PC-Axis API. The PX-Web/PC-Axis
-    API is used by organizations such as Statistics Sweden and Statistics
-    Finland to disseminate data. The R package can interact with all
-    PX-Web/PC-Axis APIs to fetch information about the data hierarchy, extract
-    metadata and extract and parse statistics to R data.frame format. PX-Web is
-    a solution to disseminate PC-Axis data files in dynamic tables on the web.
-    Since 2013 PX-Web contains an API to disseminate PC-Axis files.
-VignetteBuilder: knitr
-URL: https://github.com/rOpenGov/pxweb/
+    person("Mans", "Magnusson", , "mons.magnusson@gmail.com", role = c("aut", "cre")),
+    person("Markus", "Kainu", role = "aut"),
+    person("Janne", "Huovari", role = "aut"),
+    person("Leo", "Lahti", role = "aut",
+           comment = c(ORCID = "0000-0001-5537-637X")),
+    person("Love", "Hansson", role = "ctb"),
+    person("Eydun", "Nielsen", role = "ctb"),
+    person("Bo", "Werth", role = "ctb"),
+    person("Thomas", "Runarsson", role = "ctb"),
+    person("Torbjörn", "Lindquist", role = "ctb"),
+    person("Palmar", "Thorsteinsson", role = "ctb"),
+    person("Pyry", "Kantanen", role = "ctb"),
+    person("Sebastian", "Ankargren", role = "ctb")
+  )
+Description: Generic interface for the PX-Web/PC-Axis API. The
+    PX-Web/PC-Axis API is used by organizations such as Statistics Sweden
+    and Statistics Finland to disseminate data. The R package can interact
+    with all PX-Web/PC-Axis APIs to fetch information about the data
+    hierarchy, extract metadata and extract and parse statistics to R
+    data.frame format. PX-Web is a solution to disseminate PC-Axis data
+    files in dynamic tables on the web.  Since 2013 PX-Web contains an API
+    to disseminate PC-Axis files.
+License: BSD_2_clause + file LICENSE
+URL: https://github.com/rOpenGov/pxweb/,
+    https://ropengov.github.io/pxweb/, https://github.com/rOpenGov/pxweb
 BugReports: https://github.com/rOpenGov/pxweb/issues
 Depends:
     R (>= 3.5.0)
 Imports:
     checkmate,
     httr (>= 1.1),
     jsonlite
-License: BSD_2_clause + file LICENSE
 Suggests:
     knitr,
     remotes,
     rmarkdown,
     testthat (>= 0.11)
+VignetteBuilder: 
+    knitr
+Encoding: UTF-8
 RoxygenNote: 7.1.1
+X-schema.org-isPartOf: http://ropengov.org/
+X-schema.org-keywords: ropengov

README.Rmd

@@ -11,9 +11,9 @@ knitr::opts_chunk$set(
 )
 ```
 
-<br>
 
 <!-- badges: start -->
+[![rOG-badge](https://ropengov.github.io/rogtemplate/reference/figures/ropengov-badge.svg)](http://ropengov.org/)
   [![R build status](https://github.com/rOpenGov/pxweb/workflows/R-CMD-check/badge.svg)](https://github.com/rOpenGov/pxweb/actions)
 [![Coverage Status](https://coveralls.io/repos/github/rOpenGov/pxweb/badge.svg?branch=master)](https://coveralls.io/github/rOpenGov/pxweb?branch=master)
 [![Downloads](http://cranlogs.r-pkg.org/badges/grand-total/pxweb)](https://cran.r-project.org/package=pxweb)
@@ -26,7 +26,7 @@ knitr::opts_chunk$set(
 
 <br>
 
-# R tools to access PX-WEB API - the pxweb R package
+# R tools to access PX-WEB API - the pxweb R package <a href='https://ropengov.github.io/rogtemplate/'><img src='man/figures/logo.png' align="right" height="139" /></a>
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
@@ -51,14 +51,14 @@ install.packages('pxweb')
 
 Alternatively, you can get the latest stable development version:
 
-```{r, results='hide', message=FALSE}
+```{r, results='hide', message=FALSE, eval=FALSE}
 library(remotes)
 remotes::install_github('ropengov/pxweb')
 ```
 
 In some cases, the organization requires manual proxy settings. This can be set as follows:
 
-```{r, results='hide', message=FALSE}
+```{r, results='hide', message=FALSE, eval=FALSE}
 library(remotes)
 library(httr)
 set_config(
@@ -69,12 +69,12 @@ remotes::install_github('ropengov/pxweb')
 
 ```{r, results='hide', echo=FALSE}
 # This resets the config when the README is tested
-reset_config()
+httr::reset_config()
 ```
 
 ## Using the package
 
-For examples, check the [tutorial/vignette](https://htmlpreview.github.io/?https://github.com/rOpenGov/pxweb/blob/master/vignettes/pxweb.html).  
+For examples, check the [tutorial/vignette](https://ropengov.github.io/pxweb/articles/pxweb.html).  
 
 ## Problems?
 
@@ -92,7 +92,7 @@ You are welcome to contact us:
 
 ### Acknowledgements
 
-**Kindly cite this work** as follows: [Måns Magnusson](https://github.com/mansmeg), Markus Kainu, Janne Huovari, and [Leo Lahti](https://github.com/antagomir). Retrieval and analysis of PC Axis data with the pxweb package. R package version `r sessionInfo()$otherPkgs$pxweb$Version`. URL: [http://ropengov.github.io/pxweb](http://ropengov.github.io/pxweb)
+**Kindly cite this work** as follows: [Måns Magnusson](https://github.com/mansmeg), Markus Kainu, Janne Huovari, and [Leo Lahti](https://github.com/antagomir). Retrieval and analysis of PC Axis data with the pxweb package. R package version `r sessionInfo()$otherPkgs$pxweb$Version`. URL: <https://ropengov.github.io/pxweb/>
 
 We are grateful to all [contributors](https://github.com/rOpenGov/pxweb/graphs/contributors)! This project is part of [rOpenGov](http://ropengov.github.io).
 

README.md

@@ -1,7 +1,6 @@
-<br>
-
 <!-- badges: start -->
 
+[![rOG-badge](https://ropengov.github.io/rogtemplate/reference/figures/ropengov-badge.svg)](http://ropengov.org/)
 [![R build
 status](https://github.com/rOpenGov/pxweb/workflows/R-CMD-check/badge.svg)](https://github.com/rOpenGov/pxweb/actions)
 [![Coverage
@@ -18,8 +17,7 @@ GitHub](https://img.shields.io/github/stars/ropengov/pxweb.svg?style=social)](ht
 
 <br>
 
-R tools to access PX-WEB API - the pxweb R package
-==================================================
+# R tools to access PX-WEB API - the pxweb R package <a href='https://ropengov.github.io/rogtemplate/'><img src='man/figures/logo.png' align="right" height="139" /></a>
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
@@ -32,8 +30,7 @@ the PXWEB API.
 Many API services are still in their early stages, and data quality is
 sometimes compromised. Issue reports are welcome.
 
-Installation
-------------
+## Installation
 
 The easiest way to use pxweb is to simply install it from CRAN:
 
@@ -54,21 +51,18 @@ be set as follows:
     )
     remotes::install_github('ropengov/pxweb')
 
-Using the package
------------------
+## Using the package
 
 For examples, check the
-[tutorial/vignette](https://htmlpreview.github.io/?https://github.com/rOpenGov/pxweb/blob/master/vignettes/pxweb.html).
+[tutorial/vignette](https://ropengov.github.io/pxweb/articles/pxweb.html).
 
-Problems?
----------
+## Problems?
 
 See
 [TROUBLESHOOTING.md](https://github.com/rOpenGov/pxweb/blob/master/TROUBLESHOOTING.md)
 or [open an issue](https://github.com/ropengov/pxweb/issues).
 
-Contributing
-============
+# Contributing
 
 You are welcome to contact us:
 
@@ -85,7 +79,7 @@ You are welcome to contact us:
 Magnusson](https://github.com/mansmeg), Markus Kainu, Janne Huovari, and
 [Leo Lahti](https://github.com/antagomir). Retrieval and analysis of PC
 Axis data with the pxweb package. R package version . URL:
-<http://ropengov.github.io/pxweb>
+<https://ropengov.github.io/pxweb/>
 
 We are grateful to all
 [contributors](https://github.com/rOpenGov/pxweb/graphs/contributors)!

_pkgdown.yml

@@ -1,6 +1,6 @@
 reference:
 - title: All functions
-  desc: >
+  desc: |
     Listing of functions in the pxweb package
   contents:
   - '`pxweb-package`'
@@ -12,7 +12,12 @@ reference:
   - '`pxweb_test_api`'
   - '`pxweb_validate_query_with_metadata`'
 - title: Interactive functions
-  desc: >
+  desc: |
     Listing of interactive functions
-  contents:
-  - '`pxweb_interactive`'
+  contents: '`pxweb_interactive`'
+url: https://ropengov.github.io/pxweb/
+template:
+  package: rogtemplate
+  opengraph:
+    twitter:
+      site: '@rOpenGov'