From 96bdc80f895ea122bc0e3b765ffc647cfeb6b9ae Mon Sep 17 00:00:00 2001 From: Kelli Johnson Date: Wed, 18 Sep 2024 20:07:32 -0700 Subject: [PATCH] Implement suggestions made by @iantaylor-NOAA --- 06-developer-software-guide.Rmd | 8 ++++---- 10-testing.Rmd | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/06-developer-software-guide.Rmd b/06-developer-software-guide.Rmd index 7bc6a91..3e67f11 100644 --- a/06-developer-software-guide.Rmd +++ b/06-developer-software-guide.Rmd @@ -15,9 +15,9 @@ To start a codespace on the FIMS repository, follow the [GitHub documentation fo ### git -To contribute to the code, you will need git installed locally, and you may prefer to use an additional git [GUI client](https://git-scm.com/downloads/guis) such as GitKraken or GitHub Desktop. See the section on [RStudio](#rstudio) for setting up RStudio to work with git. +To contribute to the code, you will need git installed locally, and you may prefer to use an additional git [GUI client](https://git-scm.com/downloads/guis) such as GitHub Desktop. See the section on [RStudio](#rstudio) and [VS Code](#vs-code) for setting up those editors to work with git. -To install git, please follow the operating-system specific instructions available in the [git documentation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). +To install git, please contact your IT department or follow the operating-system specific instructions available in the [git documentation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). ### Development environment @@ -78,12 +78,12 @@ Additional settings for R are available in the [extension wiki](https://github.c } ``` -Other helpful VS Code extensions are available in the VScode marketplace, e.g., +Other helpful extensions for VS Code are available in the VScode marketplace, e.g., - Github Copilot: An AI tool that helps with line completion. - Live Share: Collaborate on the same file remotely with other developers. - Rewrap: Helps rewrapping comments and text lines at a specified character count. Note that to get it working it will be necessary to add [rulers](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_vertical-rulers). - GitLens (or GitLess): Adds more Git functionality. Some of the GitLens functionality is not free, and GitLess is a fork before the addition of these premium features. - - Selecting "R: Launch Rstudio Addin" from the command pallete will provide a list of addin options for RStudio. + - A list of extensions that can help make VS Code operate more like RStudio is available by typing `R: Launch Rstudio Addin' in the command pallete. #### RStudio diff --git a/10-testing.Rmd b/10-testing.Rmd index 8b4e798..e383089 100644 --- a/10-testing.Rmd +++ b/10-testing.Rmd @@ -376,6 +376,6 @@ test_that("TestName", { Simulation results might be dependent on the order of calls, leading to failed tests just because different random numbers are used or the order of the simulation changes through model development (see [FIMS-planning discussion 25](https://github.com/NOAA-FIMS/FIMS-planning/issues/25) for details). Below are some potential soluations. - Add a TRUE/FALSE parameter in each FIMS simulation module for - setting up testing seed. When testing the module, set the paramter to + setting up testing seed. When testing the module, set the parameter to TRUE to fix the seed number in R and conduct tests. If adding a TRUE/FALSE parameter does not work as expected, then carefully check simulated data from each component and make sure it is not a model coding error. - Use `set.seed()` from R to set the seed and investigate using {rstream} to generate multiple streams of random numbers to associate distinct streams of random numbers with different sources of randomness. {rstream} was specifically designed to address the issue of needing very long streams of pseudo-random numbers for parallel computations. See [the rstream paper](https://www.iro.umontreal.ca/~lecuyer/myftp/papers/rstream.pdf) and [RngStreams](http://www-labs.iro.umontreal.ca/~lecuyer/myftp/streams00/) for more details.