carpentries-incubator / managing-computational-projects

Managing Open and Reproducible Computational Projects
https://carpentries-incubator.github.io/managing-computational-projects
Other
8 stars 10 forks source link

J creview 23 07 #98

Closed jcolomb closed 11 months ago

github-actions[bot] commented 11 months ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries-incubator/managing-computational-projects/compare/md-outputs..md-outputs-PR-98

The following changes were observed in the rendered markdown documents:

 01-introduction.md (gone)                          | 211 ------
 06-ITtools.md (new)                                |  18 +
 22_contentAndMotivation.md (new)                   | 495 ++++++++++++++
 23_Ensuring-reproducibility.md (new)               | 191 ++++++
 24_SettingUp.md (new)                              | 294 +++++++++
 25_RDM.md (new)                                    | 301 +++++++++
 26_Coding.md (new)                                 | 709 +++++++++++++++++++++
 27_publications.md (new)                           | 361 +++++++++++
 28_conclusion.md (new)                             |   9 +
 config.yaml (gone)                                 | 101 ---
 files/01-introduction.md (new)                     |  72 +++
 02-motivation.md => files/02-motivation.md         |  14 +-
 03-overview.md => files/03-overview.md             |  47 +-
 .../04-reproducibility.md                          |  47 +-
 05-versioncontrol.md => files/05-versioncontrol.md |  37 +-
 07-setup.md => files/07-setup.md                   |   4 +-
 .../08-collaborativeworking.md                     |   0
 09-rdm.md => files/09-rdm.md                       |   0
 10-documentation.md => files/10-documentation.md   |   0
 11-rigour.md => files/11-rigour.md                 |   0
 12-analysis.md => files/12-analysis.md             |   0
 13-codereview.md => files/13-codereview.md         |   0
 14-codemodularity.md => files/14-codemodularity.md |   0
 15-publication.md => files/15-publication.md       |   5 +-
 16-open.md => files/16-open.md                     |   0
 17-citation.md => files/17-citation.md             |   0
 index.md                                           | 154 ++++-
 md5sum.txt                                         |  51 +-
 renv.lock (new)                                    | 584 +++++++++++++++++
 29 files changed, 3292 insertions(+), 413 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2023-07-25 07:55:11 +0000