Merge pull request #133 from rOpenSpain/131-update-data-citations

131 update data citations
rOpenSpain · Jan 28, 2025 · 3706393 · 3706393
2 parents 64776c2 + b483dce
commit 3706393
Show file tree

Hide file tree

Showing 6 changed files with 113 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,8 @@ alt="CRAN/METACRAN Downloads per month" /></a>
 
 **spanishoddata** is an R package that provides functions for
 downloading and formatting Spanish open mobility data released by the
-Ministry of Transport and Sustainable Mobility of Spain (MITMS 2024).
+Ministry of Transport and Sustainable Mobility of Spain (Ministerio de
+Transportes y Movilidad Sostenible (MITMS) 2024).
 
 It supports the two versions of the Spanish mobility data that consists
 of origin-destination matrices and some additional data sets. [The first
@@ -495,38 +496,69 @@ For more information on the package, see:
 
 ## Citation
 
-To cite spanishoddata R package and data in publications use:
+To cite the `spanishoddata` R package use:
 
 Kotov E, Lovelace R, Vidal-Tortosa E (2024). *spanishoddata*.
 doi:10.32614/CRAN.package.spanishoddata
 <https://doi.org/10.32614/CRAN.package.spanishoddata>,
 <https://github.com/rOpenSpain/spanishoddata>.
 
-MITMS (2024). “Estudio de movilidad de viajeros de ámbito nacional
-aplicando la tecnología Big Data. Informe metodológico (Study of
-National Traveler mobility Using Big Data Technology. Methodological
-Report).” Secretaría de Estado de Transportes y Movilidad Sostenible;
-Ministerio de Transportes y Movilidad Sostenible.
+To cite the official website of the mobility study use:
+
+Ministerio de Transportes y Movilidad Sostenible (MITMS) (2024).
+“Estudio de la movilidad con Big Data (Study of mobility with Big
+Data).”
 <https://www.transportes.gob.es/ministerio/proyectos-singulares/estudio-de-movilidad-con-big-data>.
 
+To cite the methodology for 2022 and onwards data use:
+
+Ministerio de Transportes y Movilidad Sostenible (MITMS) (2024).
+*Estudio de movilidad de viajeros de ámbito nacional aplicando la
+tecnología Big Data. Informe metodológico (Study of National Traveler
+mobility Using Big Data Technology. Methodological Report)*.
+<https://www.transportes.gob.es/recursos_mfom/paginabasica/recursos/a3_informe_metodologico_estudio_movilidad_mitms_v8.pdf>.
+
+To cite the methodology for 2020-2021 data use:
+
+Ministerio de Transportes, Movilidad y Agenda Urbana (MITMA) (2021).
+*Análisis de la movilidad en España con tecnología Big Data durante el
+estado de alarma para la gestión de la crisis del COVID-19 (Analysis of
+mobility in Spain with Big Data technology during the state of alarm for
+COVID-19 crisis management)*.
+<https://cdn.mitma.gob.es/portal-web-drupal/covid-19/bigdata/mitma_-_estudio_movilidad_covid-19_informe_metodologico_v3.pdf>.
+
+See package website for more details:
+https://ropenspain.github.io/spanishoddata/
+
 BibTeX:
 
-    @Manual{spanishoddata,
+    @Manual{r-spanishoddata,
       title = {spanishoddata},
       author = {Egor Kotov and Robin Lovelace and Eugeni Vidal-Tortosa},
       year = {2024},
       url = {https://github.com/rOpenSpain/spanishoddata},
       doi = {10.32614/CRAN.package.spanishoddata},
     }
 
-    @TechReport{mitma_mobility_2024_v8,
-      title = {Estudio de movilidad de viajeros de ámbito nacional aplicando la tecnología Big Data. Informe metodológico (Study of National Traveler mobility Using Big Data Technology. Methodological Report)},
-      author = {{MITMS}},
-      institution = {Secretaría de Estado de Transportes y Movilidad Sostenible; Ministerio de Transportes y Movilidad Sostenible},
+    @Misc{mitms_mobility_web,
+      title = {Estudio de la movilidad con Big Data (Study of mobility with Big Data)},
+      author = {{Ministerio de Transportes y Movilidad Sostenible (MITMS)}},
       year = {2024},
       url = {https://www.transportes.gob.es/ministerio/proyectos-singulares/estudio-de-movilidad-con-big-data},
-      urldate = {2024-12-11},
-      annotation = {https://www.transportes.gob.es/recursos_mfom/paginabasica/recursos/a3_informe_metodologico_estudio_movilidad_mitms_v8.pdf},
+    }
+
+    @Manual{mitms_methodology_2022_v8,
+      title = {Estudio de movilidad de viajeros de ámbito nacional aplicando la tecnología Big Data. Informe metodológico (Study of National Traveler mobility Using Big Data Technology. Methodological Report)},
+      author = {{Ministerio de Transportes y Movilidad Sostenible (MITMS)}},
+      year = {2024},
+      url = {https://www.transportes.gob.es/recursos_mfom/paginabasica/recursos/a3_informe_metodologico_estudio_movilidad_mitms_v8.pdf},
+    }
+
+    @Manual{mitms_methodology_2020_v3,
+      title = {Análisis de la movilidad en España con tecnología Big Data durante el estado de alarma para la gestión de la crisis del COVID-19 (Analysis of mobility in Spain with Big Data technology during the state of alarm for COVID-19 crisis management)},
+      author = {{Ministerio de Transportes, Movilidad y Agenda Urbana (MITMA)}},
+      year = {2021},
+      url = {https://cdn.mitma.gob.es/portal-web-drupal/covid-19/bigdata/mitma_-_estudio_movilidad_covid-19_informe_metodologico_v3.pdf},
     }
 
 # References
@@ -552,13 +584,10 @@ Origin-Destination Data,” August.
 
 </div>
 
-<div id="ref-mitma_mobility_2024_v8" class="csl-entry">
+<div id="ref-mitms_mobility_web" class="csl-entry">
 
-MITMS. 2024. “Estudio de Movilidad de Viajeros de Ámbito Nacional
-Aplicando La Tecnología Big Data. Informe Metodológico (Study of
-National Traveler Mobility Using Big Data Technology. Methodological
-Report).” Secretaría de Estado de Transportes y Movilidad Sostenible;
-Ministerio de Transportes y Movilidad Sostenible.
+Ministerio de Transportes y Movilidad Sostenible (MITMS). 2024. “Estudio
+de La Movilidad Con Big Data (Study of Mobility with Big Data).”
 <https://www.transportes.gob.es/ministerio/proyectos-singulares/estudio-de-movilidad-con-big-data>.
 
 </div>

diff --git a/README.qmd b/README.qmd
@@ -25,7 +25,7 @@ default-image-extension: ""
 <!-- 10.5281/zenodo.14516104 -->
 <!-- badges: end -->
 
-**spanishoddata** is an R package that provides functions for downloading and formatting Spanish open mobility data released by the Ministry of Transport and Sustainable Mobility of Spain [@mitma_mobility_2024_v8].
+**spanishoddata** is an R package that provides functions for downloading and formatting Spanish open mobility data released by the Ministry of Transport and Sustainable Mobility of Spain [@mitms_mobility_web].
 
 It supports the two versions of the Spanish mobility data that consists of origin-destination matrices and some additional data sets. [The first version](https://www.transportes.gob.es/ministerio/proyectos-singulares/estudios-de-movilidad-con-big-data/estudios-de-movilidad-anteriores/covid-19/opendata-movilidad) covers data from 2020 and 2021, including the period of the COVID-19 pandemic. [The second version](https://www.transportes.gob.es/ministerio/proyectos-singulares/estudios-de-movilidad-con-big-data/opendata-movilidad) contains data from January 2022 onwards and is regularly updated. Both versions of the data primarily consist of mobile phone positioning data, and include matrices for overnight stays, individual movements, and trips of Spanish residents at different geographical levels. See the [package website](https://rOpenSpain.github.io/spanishoddata/) and vignettes for [v1](https://rOpenSpain.github.io/spanishoddata/articles/v1-2020-2021-mitma-data-codebook) and [v2](https://rOpenSpain.github.io/spanishoddata/articles/v2-2022-onwards-mitma-data-codebook) data for more details.
 

diff --git a/inst/CITATION b/inst/CITATION
@@ -1,31 +1,52 @@
-citHeader("To cite spanishoddata R package and data in publications use:")
-
+c(
 bibentry(
-  key      = "spanishoddata",
-  bibtype  = "Manual",
-  title    = "spanishoddata",
-  author   = c(
-    person("Egor", "Kotov", , "[email protected]", role = c("aut", "cre"),
-           comment = c(ORCID = "0000-0001-6690-5345")),
-    person("Robin", "Lovelace", , "[email protected]", role = "aut",
-           comment = c(ORCID = "0000-0001-5679-6536")),
-    person("Eugeni", "Vidal-Tortosa", role = "ctb",
-           comment = c(ORCID = "0000-0001-5199-4103"))
-  ),
-  year     = "2024",
-  url      = "https://github.com/rOpenSpain/spanishoddata",
-  doi      = "10.32614/CRAN.package.spanishoddata"
-)
+       header = "To cite the `spanishoddata` R package use:",
+       key      = "r-spanishoddata",
+       bibtype  = "Manual",
+       title    = "spanishoddata",
+       author   = c(
+       person("Egor", "Kotov", , "[email protected]", role = c("aut", "cre"),
+              comment = c(ORCID = "0000-0001-6690-5345")),
+       person("Robin", "Lovelace", , "[email protected]", role = "aut",
+              comment = c(ORCID = "0000-0001-5679-6536")),
+       person("Eugeni", "Vidal-Tortosa", role = "ctb",
+              comment = c(ORCID = "0000-0001-5199-4103"))
+       ),
+       year     = "2024",
+       url      = "https://github.com/rOpenSpain/spanishoddata",
+       doi      = "10.32614/CRAN.package.spanishoddata"
+),
 
 
 bibentry(
-       key      = "mitma_mobility_2024_v8",
-       bibtype  = "TechReport",
-       title    = "Estudio de movilidad de viajeros de ámbito nacional aplicando la tecnología Big Data. Informe metodológico (Study of National Traveler mobility Using Big Data Technology. Methodological Report)",
-       author     = "MITMS",
-       institution = "Secretaría de Estado de Transportes y Movilidad Sostenible; Ministerio de Transportes y Movilidad Sostenible",
+       header = "To cite the official website of the mobility study use:",
+       key      = "mitms_mobility_web",
+       bibtype  = "Misc",
+       title    = "Estudio de la movilidad con Big Data (Study of mobility with Big Data)",
+       author   = person("Ministerio de Transportes y Movilidad Sostenible (MITMS)"),
        year     = "2024",
        url      = "https://www.transportes.gob.es/ministerio/proyectos-singulares/estudio-de-movilidad-con-big-data",
-       urldate  = "2024-12-11",
-       annotation = "https://www.transportes.gob.es/recursos_mfom/paginabasica/recursos/a3_informe_metodologico_estudio_movilidad_mitms_v8.pdf"
+),
+
+bibentry(
+       header = "To cite the methodology for 2022 and onwards data use:",
+       key      = "mitms_methodology_2022_v8",
+       bibtype  = "Manual",
+       title    = "Estudio de movilidad de viajeros de ámbito nacional aplicando la tecnología Big Data. Informe metodológico (Study of National Traveler mobility Using Big Data Technology. Methodological Report)",
+       author   = person("Ministerio de Transportes y Movilidad Sostenible (MITMS)"),
+       year     = "2024",
+       url      = "https://www.transportes.gob.es/recursos_mfom/paginabasica/recursos/a3_informe_metodologico_estudio_movilidad_mitms_v8.pdf",
+),
+
+bibentry(
+       header = "To cite the methodology for 2020-2021 data use:",
+       key      = "mitma_methodology_2020_v3",
+       bibtype  = "Manual",
+       title    = "Análisis de la movilidad en España con tecnología Big Data durante el estado de alarma para la gestión de la crisis del COVID-19 (Analysis of mobility in Spain with Big Data technology during the state of alarm for COVID-19 crisis management)",
+       author   = person("Ministerio de Transportes, Movilidad y Agenda Urbana (MITMA)"),
+       year     = "2021",
+       url      = "https://cdn.mitma.gob.es/portal-web-drupal/covid-19/bigdata/mitma_-_estudio_movilidad_covid-19_informe_metodologico_v3.pdf",
+)
 )
+
+citFooter("See package website for more details: https://ropenspain.github.io/spanishoddata/")
diff --git a/vignettes/convert.qmd b/vignettes/convert.qmd
@@ -58,7 +58,7 @@ In our tests (see @fig-csv-duckdb-parquet-speed), we found that conducting an an
 For reference, here is a simple query we used for speed comparison in @fig-csv-duckdb-parquet-speed:
 
 ```r
-# data represents either CSV files acquired from `spod_get()`, a `DuckDB` database or a folder of Parquet files connceted with `spod_connect()`
+# data represents either CSV files acquired from `spod_get()`, a `DuckDB` database or a folder of Parquet files connected with `spod_connect()`
 data |>
   group_by(id_origin, id_destination, time_slot) |> 
   summarise(mean_hourly_trips = mean(n_trips, na.rm = TRUE),

diff --git a/vignettes/references.bib b/vignettes/references.bib
@@ -8,23 +8,25 @@ @article{lovelace_od_2024
 	year = {2024}
 }
 
-@techreport{mitma_data_v1,
-  title = {Analysis of mobility in {{Spain}} with  {{Big Data}} Technology during the  State of Alarm for {{COVID-19}} Crisis  Management. ({{An{\'a}lisis}} de La Movilidad En {{Espa{\~n}a}}  Con Tecnolog{\'i}a {{Big Data}} Durante El  Estado de Alarma Para La Gesti{\'o}n  de La Crisis Del {{COVID-19}})},
-  author = {{Secretar{\'i}a de Estado de Transportes, Movilidad y Agenda Urbana}},
+@Misc{mitms_mobility_web,
+  title = {Estudio de la movilidad con Big Data (Study of mobility with Big Data)},
+  author = {{Ministerio de Transportes y Movilidad Sostenible (MITMS)}},
+  year = {2024},
+  url = {https://www.transportes.gob.es/ministerio/proyectos-singulares/estudio-de-movilidad-con-big-data},
+}
+
+@Manual{mitma_methodology_2020_v3,
+  title = {Análisis de la movilidad en España con tecnología Big Data durante el estado de alarma para la gestión de la crisis del COVID-19 (Analysis of mobility in Spain with Big Data technology during the state of alarm for COVID-19 crisis management)},
+  author = {{Ministerio de Transportes, Movilidad y Agenda Urbana (MITMA)}},
   year = {2021},
-  annotation = {https://cdn.mitma.gob.es/portal-web-drupal/covid-19/bigdata/mitma\_-\_estudio\_movilidad\_covid-19\_informe\_metodologico\_v3.pdf},
-  urldate = {2024-07-23},
-  url = {https://www.transportes.gob.es/ministerio/proyectos-singulares/estudios-de-movilidad-con-big-data/estudios-de-movilidad-anteriores/covid-19/opendata-movilidad}
+  url = {https://cdn.mitma.gob.es/portal-web-drupal/covid-19/bigdata/mitma_-_estudio_movilidad_covid-19_informe_metodologico_v3.pdf},
 }
 
-@techreport{mitma_mobility_2024_v8,
-  title       = {Estudio de movilidad de viajeros de ámbito nacional aplicando la tecnología Big Data. Informe metodológico (Study of National Traveler mobility Using Big Data Technology. Methodological Report)},
-  author      = {MITMS},
-  institution = {Secretaría de Estado de Transportes y Movilidad Sostenible; Ministerio de Transportes y Movilidad Sostenible},
-  year        = {2024},
-  url         = {https://www.transportes.gob.es/ministerio/proyectos-singulares/estudio-de-movilidad-con-big-data},
-  urldate     = {2024-12-11},
-  note        = {PDF available at: \url{https://www.transportes.gob.es/recursos_mfom/paginabasica/recursos/a3_informe_metodologico_estudio_movilidad_mitms_v8.pdf}}
+@Manual{mitms_methodology_2022_v8,
+    title = {Estudio de movilidad de viajeros de ámbito nacional aplicando la tecnología Big Data. Informe metodológico (Study of National Traveler mobility Using Big Data Technology. Methodological Report)},
+    author = {{Ministerio de Transportes y Movilidad Sostenible (MITMS)}},
+    year = {2024},
+    url = {https://www.transportes.gob.es/recursos_mfom/paginabasica/recursos/a3_informe_metodologico_estudio_movilidad_mitms_v8.pdf},
 }
 
 

diff --git a/vignettes/v1-2020-2021-mitma-data-codebook.qmd b/vignettes/v1-2020-2021-mitma-data-codebook.qmd
@@ -20,7 +20,7 @@ You can view this vignette any time by running:
 spanishoddata::spod_codebook(ver = 1)
 ```
 
-The mobility data v1 (2020-2021) was originally released by the Ministerio de Transportes, Movilidad y Agenda Urbana (MITMA) , now [Ministerio de Transportes y Movilidad Sostenible (MITMS)](https://www.transportes.gob.es/) [@mitma_data_v1]. 
+The mobility data v1 (2020-2021) was originally released by the Ministerio de Transportes, Movilidad y Agenda Urbana (MITMA) , now [Ministerio de Transportes y Movilidad Sostenible (MITMS)](https://www.transportes.gob.es/) [@mitma_methodology_2020_v3]. 
 
 The dataset is produced by [Nommon](https://www.nommon.es/){target="_blank"} using the raw data from [Orange España](https://www.orange.es/){target="_blank"}. Even though the raw data is only from one mobile phone operator, the resulting flows and other counts of number of individuals in the data set are already resampled to be representative of the total population of Spain (see details in the official methodology).