-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.qmd
96 lines (63 loc) · 6.11 KB
/
README.qmd
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
# mastersthesis
<!-- quarto render --profile gfm -->
```{r}
#| label: setup
#| include: false
source(here::here("R", "_setup.R"))
```
<!-- badges: start -->
[](https://www.repostatus.org/#active)
[](https://doi.org/10.17605/OSF.IO/YGKTS)
[](https://choosealicense.com/licenses/mit/)
[](https://creativecommons.org/licenses/by/4.0/)
<!-- badges: end -->
## Overview
☀🌙⏰🛌💤🌍🗺️🧭📅🧬🧠🕰️📊📉📈📝
This repository contains the [Quarto book](https://quarto.org/docs/books/) of my Master's Thesis: *Is Latitude Associated with Chronotype?* The research compendium is accessible via [The Open Science Framework](https://osf.io/) by clicking [here](https://doi.org/10.17605/OSF.IO/YGKTS).
The assemble of this repository was inspired by Ben Marwick, Carl Boettiger & Lincoln Mullen's article [Packaging Data Analytical Work Reproducibly Using R (and Friends)](https://doi.org/10.1080/00031305.2017.1375986).
## How to use
All analyses in this thesis are fully reproducible and were conducted using the [R programming language](https://www.r-project.org/) alongside the [Quarto](https://quarto.org/) publishing system. The [`renv`](https://rstudio.github.io/renv/) package was used to ensure that the R environment used can be restored (see `renv.lock`). All the computational notebooks can be found in the `qmd` directory.
It's important to note that some restrictions apply to the availability of the main research data, which contain personal and sensitive information. As a result, this data cannot be publicly shared. To run the analyses, users must have an internet connection and request a set of access keys from the author (see *Keys* section).
If you don't feel comfortable with R, I strongly recommend checking Hadley Wickham and Garrett Grolemund's free and online book [R for Data Science](https://r4ds.hadley.nz/) and the Coursera course from John Hopkins University [Data Science: Foundations using R](https://www.coursera.org/specializations/data-science-foundations-r).
To reproduce the analyses do the following steps:
1. Make sure that you have the latest R version and the following R packages installed in your machine: `install.packages(c("cli", "here" ,"magrittr", "ragg", "renv", "stats", "stringr"))`.
1. Clone this repository.
1. Open the R project (`mastersthesis.Rproj`).
1. Run [`renv::restore()`](https://rstudio.github.io/renv//reference/restore.html) to install all software dependencies.
1. Set all the keys provided by the author in the `.Renviron` file and the `_ssh` folder.
1. Run `targets::tar_make()` to create every point of the data wrangling process (from the raw data to the cleaned and weighted data).
1. Run any analysis present in the computational notebooks (`qmd` directory).
## Keys
To access the data and run the notebooks, you will need to set the following keys in the [`.Renviron`](https://bookdown.org/csgillespie/efficientR/set-up.html#:~:text=2.4.6%20The%20.Renviron%20file) file:
- `OSF_PAT`: Your [OSF](https://osf.io/) Personal Access Token (PAT). If you don't have one, go to the settings section of your OSF account and create a new token.
- `MASTERSTHESIS_PASSWORD`: The password for the project's RSA private key (32 bytes).
Additionally, you will need the following keys in the project's `_ssh` folder:
- `id_rsa`: The project's private RSA key (RSA 4096 bits (OpenSSL)).
- `id_rsa.pub`: The project's public RSA key.
These project's keys will be provided by the author of the thesis upon reasonable request. As reasonable requests, I consider those made by researchers with a legitimate interest in the thesis topic, whose projects are of high quality, ethically conducted, and who have obtained all necessary approvals for their research proposal.
## License
[](https://opensource.org/license/mit/)
[](https://creativecommons.org/licenses/by/4.0/)
The code accompanying this thesis is distributed under the [MIT License](https://opensource.org/license/mit/). All documents are released under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/).
The research data is subject to a private license and is not publicly available due to privacy and ethical considerations.
## Citation
To cite this work, please use the following format:
Vartanian, D. (`r env_vars[["year"]]`). *`r env_vars[["title"]] |> stringr::str_to_sentence()`* [`r env_vars[["academic-title"]]`'s `r env_vars[["type-of-work"]]`, `r env_vars[["university"]]`]. [https://doi.org/10.17605/OSF.IO/YGKTS](https://doi.org/10.17605/OSF.IO/YGKTS)
A BibTeX entry for LaTeX users is:
```
@mastersthesis{vartanian`r env_vars[["year"]]`,
title = {`r env_vars[["title"]] |> stringr::str_to_sentence()`},
author = {Daniel Vartanian},
year = {`r env_vars[["year"]]`},
address = {`r env_vars[["location"]]`},
school = {`r env_vars[["university"]]`},
langid = {`r env_vars[["language"]]`},
url = {https://doi.org/10.17605/OSF.IO/YGKTS},
note = {`r env_vars[["version-note"]]`}
}
```
## Acknowledgments
The thesis was developed in the Graduate Program in Modeling Complex Systems ([PPG-SCX](https://www.prpg.usp.br/pt-br/faca-pos-na-usp/programas-de-pos-graduacao/621-modelagem-de-sistemas-complexos)) at the University of São Paulo ([USP](https://www5.usp.br/)), under the supervision of [Prof. Dr. Camilo Rodrigues Neto](https://orcid.org/0000-0001-6783-6695).
<a href="https://www.gov.br/capes/"><img src= "images/capes_logo_horizontal_rgb.png" height="35"/></a>
This study was financed by the Coordenação de Aperfeiçoamento de Pessoal de Nível Superior - Brazil ([CAPES](https://www.gov.br/capes/)) - Finance Code 001, Grant Number 88887.703720/2022-00.