-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
110 lines (79 loc) · 4.37 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
---
output: github_document
format:
html:
toc: false
---
<!-- README.md is generated from README.Rmd. Please edit that file and devtools::build_rmd("README.Rmd")-->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# monitorOSM <a href="https://osm-catalan.github.io/monitorOSM"><img src='man/figures/logo.svg' align="right" height=130 alt="Web de monitorOSM"/></a>
<!-- badges: start -->
[](https://github.com/OSM-Catalan/monitorOSM/actions/workflows/quarto-publish.yml)
[](https://github.com/OSM-Catalan/monitorOSM/actions/workflows/pkgdown.yaml)
[](https://github.com/OSM-Catalan/monitorOSM/actions/workflows/R-CMD-check.yaml)
[](https://github.com/OSM-Catalan/monitorOSM/actions/workflows/pre-commit.yaml)
<!-- [](https://github.com/OSM-Catalan/monitorOSM/actions/workflows/test-coverage.yaml) -->
<!-- badges: end -->
`monitorOSM` és un repositori que serveix per monitoritzar canvis a [OpenStreetMap](http://www.openstreemap.com)
comparant els objectes amb [bases de dades de referència](https://github.com/OSM-Catalan/monitorOSM/tree/main/data-raw).
Podeu veure els informes que s'actualitzen diàriament a <https://osm-catalan.github.io/monitorOSM>. Els informes de
canvis mostren taules amb l'estat de les etiquetes a OSM i a les bases de dades de referència:
```{r exemple diferències, echo=FALSE}
referencia <- data.frame(
osm_url = "http://osm.org/node/XXXX", `name:ca` = "nom de referència", name = "Sense canvis",
wikipedia = "ca:Eliminat", check.names = FALSE
)
osm <- data.frame(
osm_url = "http://osm.org/node/XXXX", `name:ca` = "nom a OSM", name = "Sense canvis",
wikipedia = NA_character_, check.names = FALSE
)
dif <- suppressWarnings(suppressMessages(
compareDF::compare_df(df_new = osm, df_old = referencia, group_col = "osm_url", stop_on_error = FALSE)
))
suppressMessages(compareDF::create_output_table(dif, change_col_name = "canvi"))
```
També es mostra quins conjunts de canvis han trencat les etiquetes amb enllaços per si es vol deixar comentaris.
## Afegir nous objectes a les bases de dades
Si voleu afegir objectes amb les seves etiquetes a les bases de dades, podeu obrir un
[tiquet](https://github.com/OSM-Catalan/monitorOSM/issues) o podeu provar de fer un PR amb les instruccions que trobareu
a [aquí](https://osm-catalan.github.io/monitorOSM/data-raw/README.html). Fora bo que els estats de referència
dels objectes siguin consensuats amb la
[Comunitat d'OpenStreetmap en català](https://wiki.openstreetmap.org/wiki/WikiProject_Catalan#Canals_de_comunicaci%C3%B3_i_mitjans_de_difusi%C3%B3).
## Paquet d'R
La consulta, comparació amb bases de dades de referència i renderització de la web es fan amb un paquet
d'[R](https://cran.r-project.org/) i accions de github. El paquet també inclou funcions per restaurar els objectes de
manera ràpida, però com a projecte comunitari, és important intentar parlar amb els usuaris que discrepen de les bases
de dades de referència. Vegeu la [documentació del paquet d'R](https://osm-catalan.github.io/monitorOSM/docs/reference/)
per més detalls.
### Exemples d'ús del paquet
Instal·leu el paquet d'R:
``` r
# install.packages("remotes")
remotes::install_github("OSM-Catalan/monitorOSM")
```
### Generació dels informes locals
Per refrescar els informes localment i veure la web, podeu clonar el repositori i des d'R situat a la carpeta del
projecte:
```r
# install.packages("quarto")
library(quarto)
quarto_render()
```
#### Exemple de restauració
Restauració de les etiquetes `name` i `wikipedia` de les comarques del País Valencià:
``` r
library(monitorOSM)
id <- modifica_etiquetes_osm(
comarques[comarques$regio == "PV", ],
claus = c("name", "wikipedia"),
comentari = "Restaura els noms de les comarques dels País Valencià", hashtags = "monitorOSM"
)
```
Retorna l'identificador del conjunt de canvis.