This repository contains a helper software project with some code to be used for the Advanced R - Reproducibility with R course.
This repository is an example of "not so reproducible" code project that is meant to be improved over the course to show examples of reproducible coding practices.
Various branches of this repository represent the state of the code as it should be at the start of each of the course episodes:
- Episodes "1. Course introduction", "2. Good Practices" are not making changes to the software
- branch 03-code-readability matches the code at the start of episode "3. Code Readability"
- branch 04-project-structure matches the code at the start of episode "4. Project Structure"
- branch 05-code-documentation matches the code at the start of episode "5. Code Documentation"
- branch 06-code-correctness matches the code at the start of episode "6. Code Correctness"
- branch 07-code-environment matches the code at the start of episode "7. Code Environment"
- branch 08-wrap-up matches the code at the start of episode "3. Code Readability"
The code uses the NASA data on human space walks (Extravehicular activities - EVAs), exported/downloaded in JSON format, does some analysis over this data, plots a few graphs and saves the data in CSV format.
An example of better and more reproducible code that participants should strive to achieve when writing their reseach software can be found on the final branch branch 08-wrap-up.
The data used on in this project was obtained from NASA as follows.
Data source: https://data.nasa.gov/Raw-Data/Extra-vehicular-Activity-EVA-US-and-Russia/9kcy-zwvn/about_data.
Either export data from the above page using the Export button or download in JSON format from command line as:
curl https://data.nasa.gov/resource/eva.json --output eva-data.json
Note: the original data has been modified for the purposes of this tutorial by inserting a semicolon separator after each name in the crew field.
This repository is an R-port (with modifications to match the flow of our course) of the helper software code from the FAIR research software course. reused and modified under MIT license.
The original licence text from the helper software code is provided here:
MIT License
Copyright (c) 2024 carpentries-incubator
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
See
