Respository ERC-SG

Repositorio para trabajar en la propuesta de proyecto para la convocatoria "Starting Grants" del "European Research Council"

License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International Public License. Please see the license file.

Attributions

This project makes use of the rproj-template Github template created by Daniel Morillo and licensed under the Creative Commons Attribution 4.0 International license.

Project installation

Software components

To work on this project locally, the best option is to install Rstudio. In order to install it, please install the following software components:

• Install R version 4.2.2: In Windows, using the binary installer is recommended.

• Rstudio Desktop: Although not strictly necessary, it is recommended to install the Rstudio IDE; for strict reproducibility, use build 2022.07.1+554 for Windows 10/11.

Alternatively, one can simply work on a simple text-file processing application (i.e. Windows built-in notepad). If you prefer to use a notepad application, I suggest installing the latest version of Notepad++ or Sublime text.

Also, a Git client will be necessary:

• Git client: Install the Git client in order to be able to clone locally the project repository. On Windows, use the 64-bit Windows installer.

Installing the project locally

This project is hosted as a GitHub repository. It can be cloned as a local Git repository following these instructions (steps 2 through 7). Note that this will create a local copy of ('clone') the GitHub repository as an Rstudio project in the folder specified. The URL that must be entered into the Repository URL text box is:

https://github.com/DaniMori/ERC-SG.git

After cloning the repository, the Rstudio project will open automatically in the Rstudio IDE. If it doesn't, or you want to return later to the project in Rstudio, you can do so by double clicking on the file rstudio_project.Rproj that has been created in the project folder when cloning the repository.

NOTE: It is common practice to avoid using and versioning .Rprofile files. However, this project uses package renv to create a reproducible environment, which needs the .Rprofile file that lives in the root directory of the project. Please DO NOT delete or edit this file; it will install and activate the renv package and make it ready for restoring the environment.

Restoring the environment

The reproducible environment created by renv must be restored to install all the packages this project needs to be built properly. Use the "renv" => "Restore library..." button in Rstudio's "Packages" tab to restore the environment. Alternatively, you can type in the console:

renv::restore()

Repository structure

The file structure of this repository is as follows:

ERC-SG
|
|--- dat       (To store input datasets; must NEVER be checked-in to Github)
|
|--- doc       (To store important documentation of the project)
|    |
|    |--- minutes (To store meeting minutes)
|
|--- notebooks (Notebooks to explore data and test processes live here)
|
|--- output    (Processing outputs; files must be individually "checked-in" if necessary)
|
|--- R         (R functions created for this project live here)
|
|--- renv      (System library necesssary for `renv` to work. DON'T TOUCH)
|
|--- src       (Source scripts that implement the main processes)
|
|--- www       (Project assets, e.g., images, bibliography files, etc.)

Use the folders as indicated to store the different files and generate the outputs of the processes.