Skip to content

Domain Review for software release

Following a discussion on 08/27/24, the Vizlab team has decided to move forward with website releases being "Scientific software" releases, whereby:

This issue documents the need for domain review prior to release of this code as an official software release. This issue will be assigned a DRAFT label until the code is finalized, at which time Cee Nell should be tagged to delegate the review

Associated visualizations

R_src/processing_code_massVflow.qmd produces this figure:

image

R_src/processing_code_growthVtemp.qmd produces this figure:

image

R_src/processing_code_streamTemp.qmd produces this figure:

image

Review needs

Document what portion of the code needs review, what type of review is needed, and what language the code to be reviewed is in.

Portion of code Type of review needed Language Link to code/ section of pipeline Person designated for review
Downloads and documents data sourced from ScienceBase
  • Data fetching
  • Statistics
  • Modeling
  • Data visualization
  • R
  • Python
  • JavaScript
R_src/01_fetch_data.qmd

Reviewed by @cnell in !35 (merged)
Uses fish lengths and biometric model to calculate fish mass to create mass v. flow viz. Uses code from script provided by authors of manuscript.
  • Data processing
  • Statistics
  • Modeling
  • Data visualization
  • R
  • Python
  • JavaScript
R_src/02_visualize_growthVtemp.qmd

Reviewed by @cnell in !35 (merged)
Matches fish growth model data and stream temperatures to create growth rate v. temp viz
  • Data processing
  • Statistics
  • Modeling
  • Data visualization
  • R
  • Python
  • JavaScript
R_src/03_visualize_growthVtemp.qmd

To be reviewed by @cnell
Uses ScienceBase data to create a data visualization of stream temperatures for one example reach
  • Data processing
  • Statistics
  • Modeling
  • Data visualization
  • R
  • Python
  • JavaScript
R_src/04_visualize_streamTemp.qmd

Reviewed by @cnell in !35 (merged)
Builds storytelling website
  • Data processing
  • Statistics
  • Modeling
  • Data visualization
  • R
  • Python
  • JavaScript
Vue code

Approach to storytelling navigation was reviewed through MR process in:

Additional review of website from @hcorson-dosch

Related issues

Accessibility features were documented in Issue #22 (closed)

Context for domain review

Scientific Software. Software containing source code implementing scientific algorithms or producing scientific data. It may include any custom developed code yielding scientific results, thereby facilitating a clear scientific workflow of analysis, scientific integrity, and reproducibility.

which requires domain review:

Domain reviews are specific to Scientific Software (Refer to Scientific Software IM) and ensure the software generates output that aligns with published or otherwise well-known expected results. Domain reviews may involve:

  • Comparing output with external data sets
  • Comparing algorithms with published, scholarly articles about the algorithm
  • Reviewing unit and integration test results

Domain reviews should be performed by a trusted scientific expert with applicable subject-matter knowledge as well as sufficient applicable programming knowledge.

Edited by Cee Nell