search

e-kotov / 2024-EDSD-open-science-quarto-github

http://www.ekotov.pro/2024-EDSD-open-science-quarto-github/
1 stars 1 forks source link

João Victor Antunes Lopes #4

Open jvalopes opened 3 weeks ago

jvalopes commented 3 weeks ago

Thank you very much for the workshop!

https://github.com/jvalopes/edsd2024_open_science

e-kotov commented 3 weeks ago

Hi @jvalopes ! Thanks for your submission! A few comments:

  1. You are "missing" just one last step, publishing your index.html from the docs folder at https://jvalopes.github.io//edsd2024_open_science/ . If you want to do it, just keep following the tutorial.

  2. Your block with data preview and summaries does not output anything, but the code is printed. This may not be a desired behavior. Usually, you only print the code without any output when you provide a code example. Otherwise you either would also print an output, or not include the code at all in the final version.

  3. You have a nice overview small multiples plot showing destinations of Brazilian scholars.

  4. Good job referencing all the tutorials and data sources.

  5. Some headings in your report are not very informative (like "Applying the steps to my data frame" - which steps?)

  6. You applied a nice looking theme to the document, and good job using custom code block options to hide certain messages and warnings or even entire code blocks.

  7. Since you did save your MAPBOX token in the repository, I would suggest to either limit the use of that key in your account to just your domain (jvalopes.github.io), so that no one else could use it, even though the free quota is quite generous. In this case, you will not see the map background if you open it locally on your computer, but it will work when it is online. Alternatively, you can also just delete the key from your account (in which case of course your published map will not work anymore). To keep your API key private you usually add it to an .Renviron file in the project folder and then access it with Sys.getenv(), so that the key is not baked into the code. However, in this case, this would not be relevant, as the key is baked into the flowmap.html anyway.