Skip to content

Commit

Permalink
push files
Browse files Browse the repository at this point in the history
  • Loading branch information
amitjavilaventura committed Jan 27, 2021
1 parent 1665c41 commit 5f69d79
Show file tree
Hide file tree
Showing 25 changed files with 626 additions and 43 deletions.
2 changes: 1 addition & 1 deletion .Rproj.user/37E9A777/sources/prop/5C0D1AE0
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"cursorPosition" : "22,14",
"cursorPosition" : "28,19",
"scrollLine" : "0"
}
4 changes: 4 additions & 0 deletions .Rproj.user/37E9A777/sources/prop/74882F04
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"cursorPosition" : "9,3",
"scrollLine" : "0"
}
5 changes: 3 additions & 2 deletions .Rproj.user/37E9A777/sources/prop/803BCA5F
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"cursorPosition" : "184,678",
"scrollLine" : "162"
"cursorPosition" : "86,4",
"last_setup_crc32" : "78D8DB3Eb3adf965",
"scrollLine" : "0"
}
2 changes: 1 addition & 1 deletion .Rproj.user/37E9A777/sources/prop/F1C17BCB
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"cursorPosition" : "1,20",
"cursorPosition" : "6,119",
"scrollLine" : "0"
}
1 change: 1 addition & 0 deletions .Rproj.user/37E9A777/sources/prop/INDEX
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
~%2FDesktop%2FAdria%2FOther%2FASBTEC%2FArticlesWeb%2FRmarkdown_web%2Frmarkdown_web.Rmd="803BCA5F"
~%2FDesktop%2FAdria%2FOther%2FASBTEC%2Fasbtec_blogdown%2Fcontent%2Fposts%2F002-web-rmarkdown-github%2Frmarkdown_web.Rmd="74882F04"
~%2FDesktop%2FAdria%2FOther%2FASBTEC%2Fasbtec_blogdown%2Fcontent%2Fposts%2F2020-12-01-r-rmarkdown%2Findex.Rmd="2104C7F"
~%2FDesktop%2FAdria%2FOther%2FASBTEC%2FprovaWeb%2FUntitled.Rmd="8A9C864F"
~%2FDesktop%2FAdria%2FOther%2FASBTEC%2FprovaWeb%2F_site.yml="5C0D1AE0"
Expand Down
262 changes: 262 additions & 0 deletions .Rproj.user/37E9A777/sources/s-78D8DB3E/3275A8AA-contents

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .Rproj.user/37E9A777/sources/s-78D8DB3E/4AA0E0E6
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"path" : "~/Desktop/Adria/Other/ASBTEC/provaWeb/_site.yml",
"project_path" : "_site.yml",
"properties" : {
"cursorPosition" : "22,14",
"cursorPosition" : "28,19",
"scrollLine" : "0"
},
"read_only" : false,
Expand Down
25 changes: 0 additions & 25 deletions .Rproj.user/37E9A777/sources/s-78D8DB3E/4B7CBB07

This file was deleted.

80 changes: 75 additions & 5 deletions .Rproj.user/37E9A777/sources/s-78D8DB3E/4B7CBB07-contents
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ output:
toc: no
toc_depth: 3
toc_float: no
self_contained: false

---

```{r setup, include=FALSE}
Expand Down Expand Up @@ -74,27 +76,29 @@ Un cop tinguem R i RStudio instal·lats, els passos a seguir (dins d'RStudio) pe
6. Carregar (fer *commit* i *push*) de tota la carpeta on tenim els fitxers de la pàgina web al repositori `usuari.github.io`.
7. Configurar el repositori per a habilitar les *GitHub pages* i dir-li a GitHub on ha de buscar els documents HTML.

## Pas 1. Instal·lar les dependències.
## Pas 1. Instal·lar les dependències

Els paquets que haurem d'instal·lar són paquets dedicats a la creació de pàgines web i blogs. D'aquests n'hi ha molts, encara que nosaltres ens basarem en el paquet `rmarkdown`:

* **`rmarkdown`**: paquet senzill que ens aporta diverses utilitats del llenguatge *Rmarkdown* i que ens permet utilitzar una plantilla senzilla per a la creació de pàgines web (però no blogs). Podeu trobar més informació sobre aquest paquet a <https://rmarkdown.rstudio.com/lesson-1.html> i instal·lar-lo mitjançant l'ordre `install.packages("rmarkdown")`.
* **`distill`**: paquet que ens permet utilitzar més plantilles per a fer una web o un blog, així com funcions que ens permetran crear publicacions i/o pàgines pel nostre lloc web de manera molt senzilla, ja que la seva estructura és molt similar a les webs creades amb el paquet `rmarkdown`, amb molts avantatges i alguns inconvenients. Podeu trobar més informació sobre aquest paquet a <https://rstudio.github.io/distill/> i instal·lar-lo mitjançant l'ordre `install.packages("distill")`.
* **`blogdown`**: paquet especialitzat en la creació de blogs, que ens permet tenir una flexibilitat a l'hora de configurar la nostra web i que disposa de diversos temes per a donar un format visual diferent al blog que crearem. És una mica més complicat d'utilitzar, però podeu trobar-ne més informació a <https://bookdown.org/yihui/blogdown/> i instal·lar-lo mitjançant l'ordre `install.packages('blogdown')`.

<br>
Altres paquets per a la creació de llocs web no personals (llibres, paquets d'R, projectes en general), els quals us seran més útils si us dediqueu a la (bio)informàtica, (bio)estadística, etc:

* **`bookdown`**: aquest paquet està dissenyat per a la creació de llibres, però el format dels llibres també pot ser en línea com una pàgina web. Més informació a <https://bookdown.org/yihui/bookdown/>.
* **`pkgedown`**: paquet dissenyat per a la creació de llocs web destinats a la documentació de paquets. Més informació a <https://pkgdown.r-lib.org/>.
* **`workflowr`**: paquet dissenyat per a la creació de llocs web (ja siguin locals o publicats a internet) destinats organitzar les anàlisis i les dades d'un projecte, així com facilitar la seva reproducibilitat i la col·laboració. Més informació a <https://jdblischak.github.io/workflowr/>.

<br>
Les altres dependències dependran del codi que volguem executar a les nostres pàgines o publicacions del lloc web. A continuació teniu alguns paquets útils, encara que no els explicarem:

* `knitr`: paquet amb funcions que ens permetran incloure imatges (ex. `include_graphics()`), donar format de taula a matrius o *data frames* (ex. `kable()`), entre moltes altres, quelcom interessant a l'hora de fer CVs, etc. Més informació [aquí](https://yihui.org/knitr/).
* `tidyverse`: conjunt de paquets que fan molt senzills el tractament i modificació d'estructures de dades (matrius, *data frames*, mitjançant el paquet `dplyr`) així com la visualització de gràfics (mitjançant `ggplot2`), etc.
* ...

## Pas 2. Crear un projecte d'R.
## Pas 2. Crear un projecte d'R

```{r fig.show="hold", out.height="20%", out.width="49%", fig.align = "default", fig.cap="Figura 1. Passos necessaris per a crear un projecte d'R."}
knitr::include_graphics(c("newRproject.png", "newRproject_directory.png", "newRproject_type.png", "newRproject_name.png"))
Expand Down Expand Up @@ -178,16 +182,82 @@ Ara bé, com veieu a la **figura 2**, la qual mostra una [pàgina de prova](http

Ara ja tenim tot el que necessitem per fer la web i, si cliquem *Build Website*, podrem visualitzar-la de manera local.

## Pas 5. Crear el repositori de GitHub.
## Pas 5. Crear el repositori de GitHub

Si no tenim un compte a GitHub, haurem d'anar <https://github.com> i crear un compte seguint les instruccions. Una vegada haguem creat el compte, ja podrem crear tots els repositoris que volguem per a guardar codi. Aquí en teniu una petita [guia](https://guides.github.com/activities/hello-world/), la qual us hem deixat al principi d'aquesta mateixa publicació.

Per a guardar la vostra web, el que haureu de fer és crear un repositori amb el nom `usuari.github.io`. Per exemple, el meu usuari de GitHub és [*amitjavilaventura*](https://github.com/amitjavilaventura), per tant, el repositori que he de crear per a guardar la meva web és [`amitjavilaventura.github.io`](https://github.com/amitjavilaventura/amitjavilaventura.github.io), que serà el domini que es farà servir per allotjar el lloc web (*Figura 3*). També podem crear tots els repositoris que volguem i amb qualsevol nom per allotjar tantes webs com volguem, però aquestes webs s'allotjaran com a subdominis de la web principal (ex. `usuari.github.io/nom_repositori_secundari/`)
Per a guardar la vostra web, el que haureu de fer és crear un repositori amb el nom `usuari.github.io`. Per exemple, el meu usuari de GitHub és [*amitjavilaventura*](https://github.com/amitjavilaventura), per tant, el repositori que he de crear per a guardar la meva web és [`amitjavilaventura.github.io`](https://github.com/amitjavilaventura/amitjavilaventura.github.io), que serà el domini que es farà servir per allotjar el lloc web (*Figura 3*).


També podem crear tots els repositoris que volguem i amb qualsevol nom per allotjar tantes webs com volguem, però aquestes webs s'allotjaran com a subdominis de la web principal (ex. `usuari.github.io/nom_repositori_secundari/`).

```{r fig3, fig.show="hold", out.height="20%", out.width="100%", fig.align = "center", fig.cap="Figura 3. Passos necessaris per a la creació d'un repositori de GitHub amb objectiu d'allotjar una web."}
knitr::include_graphics(c("github_new_repo.png", "github_new_repo2.png", "github_new_repo3.png"))
```


## Pas 6. Carregar tots els fitxers al repositori

Ara que ja tenim el repositori, hem de fer carregar-hi tots els arxius necessaris. Això ho podem fer mitjançant tres mètodes:

* Des de la terminal del sistema (s'hi pot accedir des d'RStudio), una opció fàcil i ràpida una vegada la domines, però complicada d'entendre al principi.
* Des de l'aplicació de *GitHub Desktop*, una opció més assequible, però encara n'hi ha una de més fàcil.
* Des del mateix repositori de GitHub (*Figura 4*), cliquem a *uploading an existing file*, despres arrosseguem els arxius de la carpeta generada al pas 2 i cliquem a *Commit changes* (si volem podem afegir una descripció o canviar el missatge del *commit*).

```{r fig4, fig.show="hold", out.width="100%", fig.align = "center", fig.cap="Figura 4. Com carregar els arxius a un repositori de GitHub."}
knitr::include_graphics(c("github_upload_files1.png", "github_upload_files2.png"))
```


Recordeu que teniu la [guia](https://guides.github.com/activities/hello-world/) que us hem proporcionat al principi i que us pot servir de molta ajuda.

## Pas 7. Configurar

Una vegada haguem creat el repositori i hi tinguem els fitxers carregats, hem d'anar a la pestanya <i class="fas fa-cog"></i> *Settings* (*Figura 5, panell superior*) i dins d'aquesta pestanya a la secció on diu *GitHub Pages* (*Figura 5, panell inferior*) hem d'indicar la *Branch* del repositori (vosaltres en tindreu només una, que probablement es digui *master* o *main*) i la carpeta on buscar els fitxers HTML, que serà *docs* o *root* depenent el que hagiu posat a l'opció `output_dir` del fitxer `_site.yml`.

Finalment, haureu de clicar a *Save* (*Figura 5*), esperar una estona, actualitzar la pàgina i quan digui *Your site is published at ...*, ja podreu accedir a la vostra pàgina web personal.

```{r fig5, fig.show="hold", out.width="100%", fig.align = "center", fig.cap="Figura 5. Configurar el repositori de GitHub per allotjar una pàgina web."}
knitr::include_graphics(c("github_pages1.png", "github_pages2.png"))
```

## Pas 8. Gaudir del vostre lloc web

A més, si teniu un domini particular, podeu indicar que voleu que el vostre lloc web s'allotji en aquest domini i no a `usuari.github.io`.

Ara ja podeu del vostre lloc web i podeu anar-lo actualitzant.

# Recursos

A continuació us deixem alguns recursos, a més dels que ja hem anat donant al llarg de la publicació:

* *R Markdown*

+ [Guia de referència](https://rstudio.com/wp-content/uploads/2015/03/rmarkdown-reference.pdf?_ga=2.208411222.519933327.1611688102-172412930.1604399930)
+ [*Cheat sheet*](https://github.com/rstudio/cheatsheets/raw/master/rmarkdown-2.0.pdf)
+ [Introducció](https://rmarkdown.rstudio.com/lesson-1.html)
+ [Llibre](https://bookdown.org/yihui/rmarkdown/)
+ [Llocs web (capítol 10 del llibre)](https://bookdown.org/yihui/rmarkdown/websites.html)

<br>

* Paquets d'R per a fer webs:

+ [`distill`](https://rstudio.github.io/distill/)
+ [`blogdown`](https://bookdown.org/yihui/blogdown/)

<br>

* GitHub:

+ [Guia ràpida](https://guides.github.com/activities/hello-world/)
+ [*Getting started*](https://docs.github.com/en/github/getting-started-with-github)
+ [*GitHub Pages*](https://pages.github.com/)
+ [*Domini propi*](https://docs.github.com/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site)
+ [*Creating a GitHub Pages site*](https://docs.github.com/en/github/working-with-github-pages/creating-a-github-pages-site)

<br>

* Exemples:

+ [Lloc web de prova](https://asbtec.github.io/prova-web-rmarkdown/index.html)
+ [Repositori del lloc web](https://github.com/ASBTEC/prova-web-rmarkdown)
8 changes: 4 additions & 4 deletions .Rproj.user/37E9A777/sources/s-78D8DB3E/5F8DFEBF
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
"dirty" : false,
"encoding" : "UTF-8",
"folds" : "",
"hash" : "2572601057",
"hash" : "0",
"id" : "5F8DFEBF",
"lastKnownWriteTime" : 1611769289,
"last_content_update" : 1611769289693,
"lastKnownWriteTime" : 1611790365,
"last_content_update" : 1611790365206,
"path" : "~/Desktop/Adria/Other/ASBTEC/provaWeb/index.Rmd",
"project_path" : "index.Rmd",
"properties" : {
"cursorPosition" : "1,20",
"cursorPosition" : "6,119",
"scrollLine" : "0"
},
"read_only" : false,
Expand Down
4 changes: 3 additions & 1 deletion .Rproj.user/37E9A777/sources/s-78D8DB3E/5F8DFEBF-contents
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
title: "Web de prova"
---

Benvinguts a la nostra web de prova.
Benvinguts a la nostra web de prova.

Feu un cop d'ull a [aquesta publicació](https://asbtec.org/2021/01/com-fer-una-pagina-web-amb-rmarkdown-i-github-pages/) si voleu saber com l'hem fet.
Loading

0 comments on commit 5f69d79

Please sign in to comment.