Skip to content

StoX 4.1.1 See NEWS.md #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# StoX v4.1.1 (2024-12-20)

## Summary
* The StoX version 4.1.1 is a patch release which includes some important bug fixes, in particular the problem that certain floating values were shifted one integer value down in the functions ICESBiotic and ICESAcoustic. An attempt to fix this bug was made in StoX 4.1.0, but was not successful.

I addition, the resamling function "ResampleBioticAssignmentByAcousticPSU" that was introduced in StoX 4.0.0 for BioticAssignment in the function Bootstrap, is now more carefully documented in the help page of the function. Specifically, the potential risk of under-estimating the variance by using this resampling function is stated. It is adviced to carefully read the documentation before choosing between the resampling functions "ResampleBioticAssignmentByStratum" and "ResampleBioticAssignmentByAcousticPSU". I.e., there is no single ResampleFunction that can be recommended for resampling of BioticAssignment.

## General changes
* Updated the documentation of ResampleFunction in the BootstrapMethodTable of Bootstrap(). Specifically the pros and cons of ResampleFunction "ResampleBioticAssignmentByStratum" and "ResampleBioticAssignmentByAcousticPSU" are described. There are dangers to using the "ResampleBioticAssignmentByAcousticPSU" in that the variance may be lower than expected due to Hauls being resampled multiple times for the same Stratum, which smoothes out the extreme values.


## Bug fixes
* Fixed the 29 cm bug again, as it was not properly fixed in RstoxData v2.1.0. Refactored how precision is set both when reading data and in the ICESBiotic() and ICESAcoustic(). In R one example is format(29 / 100 * 100, digits = 20) = "28.999999999999996447", which results in 28 when converted to integer. The following values are affected:
* 29, 57, 58, 113, 114, 115, 116 when BiologyLengthCode is "cm" (lengthresolution "3")
* 1001, 1003, 1005, 1007, 1009, 1011, 1013, 1015, 1017, 1019, 1021 and 1023 when BiologyLengthCode is "mm" (lengthresolution "1")
* 1005 and 1015 (a subset of the values for "mm") when BiologyLengthCode is "halfcm" (lengthresolution "2")
* Fixed bug in MeanNASC() causing StratumPolygon to show in the Function inputs if the user first selects PSUDefinition = "FunctionParameter" and PSUDefinitionMethod = "EDSUToPSU" and then changing to PSUDefinition = "FunctionInput".
* Fixed bug in DefineAcousticTargetStrength() where specifying a table with the columns AcousticCategory, Frequency, TotalLength and TargetStrength in the case of AcousticTargetStrengthModel = "TargetStrengthByLength" resulted in the error message "The output from DefineAcousticTargetStrength() contains duplicated keys (AcousticCategory, Frequency) in rows 1, 2.". The reason was that only the first two columns were considered as grouping variables, whereas all three first columns should (specifying different lengths, and a target strength per length).


## Detailed changes
* Removed rscript_args from mapplyOnCores(), since this caused the Renviron to be ignored in the sub processes, resulting in errors with finding RstoxFramework in the case of multiple libraries on Linux and macOS.
* Introduced the EchoType as a column in the Data table of ICESBiotic() (and WriteICESBiotic()).
* Updated documentation of the AcousticPSU process data.
* Changed unwanted error "Passed a filename that is NOT a string of characters!" when creating a process using ReportBootstrap and clicking on the drop down list for e.g. BaselineProcess, to a warning "Bootstrap output NetCDF4 file missing." and with empty drop down as result.
* Added removal of temporary files: 1. Shapefiles written by setRstoxPrecision() were not completely deleted (shx, dbf and prj were not deleted). 2. The NetCDF4 file written temporarily during bootstrapping and copied to the bootstrap process output was not deleted. 3. The temporary project description file used in validation in readProjectDescription() was not deleted.
* Reverted the name change of Resample* functions back to using CamelCase and not underscore separated CamelCase (underscore between the word "Resample", the data type, and the specification):
* "Resample_MeanLengthDistributionData" -> "ResampleMeanLengthDistributionData"
* "Resample_MeanSpeciesCategoryCatchData" -> "ResampleMeanSpeciesCategoryCatchData"
* "Resample_PreySpeciesCategoryCatchData_HierarchicalUsingScaling" -> "ResamplePreySpeciesCategoryCatchData"
* "Resample_BioticAssignment_ByStratum" -> "ResampleBioticAssignmentByStratum"
* "Resample_BioticAssignment_ByAcousticPSU" -> "ResampleBioticAssignmentByAcousticPSU"
* "Resample_MeanNASCData" -> "ResampleMeanNASCData"
* Added message when replaceDataList or replaceArgsList is used.


# StoX v4.1.0 (2024-11-04)

## Summary
Expand Down
5 changes: 3 additions & 2 deletions Official_StoX_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ Official StoX versions are fully tested and are the only one that should be used
| 3.6.0| 3.6.0| 1.11.0| 1.8.0| | 2023-01-16| [StoX-v3.6.0](https://github.com/StoXProject/StoX/releases/tag/v3.6.0)| R 3.6 - 4.
| 3.6.1| 3.6.1| 1.11.2| 1.9.0| 1.2.0| 2023-05-10| [StoX-v3.6.1](https://github.com/StoXProject/StoX/releases/tag/v3.6.1)|
| 3.6.2| 3.6.2| 1.11.3| 1.10.1| 1.2.0| 2023-06-28| [StoX-v3.6.2](https://github.com/StoXProject/StoX/releases/tag/v3.6.2)| R <= 4.3
| 4.0.0| 4.0.0| 2.0.0| 2.0.0| 1.2.0| 2023-07-10| [StoX-v4.0.0](https://github.com/StoXProject/StoX/releases/tag/v4.0.0)|
| 4.1.0| 4.1.0| 2.1.0| 2.1.0| 1.2.0| 2023-11-04| [StoX-v4.1.0](https://github.com/StoXProject/StoX/releases/tag/v4.1.0)| R >= 4.3
| 4.0.0| 4.0.0| 2.0.0| 2.0.0| 1.2.0| 2024-07-10| [StoX-v4.0.0](https://github.com/StoXProject/StoX/releases/tag/v4.0.0)|
| 4.1.0| 4.1.0| 2.1.0| 2.1.0| 1.2.0| 2024-11-06| [StoX-v4.1.0](https://github.com/StoXProject/StoX/releases/tag/v4.1.0)| R >= 4.3
| 4.1.1| 4.1.1| 2.1.1| 2.1.1| 1.3.0| 2024-12-20| [StoX-v4.1.1](https://github.com/StoXProject/StoX/releases/tag/v4.1.1)| R >= 4.3
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ StoX is an open source software developed at IMR, Norway, to analyze survey data

The following describes installation of the latest *official* StoX version (Se [all official StoX versions](https://github.com/StoXProject/StoX/blob/master/Official_StoX_versions.md)). For unofficial versions installation of the Rstox-packages must be done in R (details given at the end of this paragraph). It is highly recommended to use official versions, as these are fully tested, whereas tetsting is limited for unofficial versions.

See [release notes for StoX 4.1.0](https://github.com/StoXProject/StoX/blob/master/NEWS.md#stox-v410-2024-11-04).
See [release notes for StoX 4.1.1](https://github.com/StoXProject/StoX/blob/master/NEWS.md#stox-v411-2024-12-20).

Download StoX from (https://github.com/StoXProject/StoX/releases/tag/v4.1.0). For Windows download the .msi file, for MacOS download the .dmg file and for Linux download the .rpm or .deb file. Then follow the instructions below:
Download StoX from (https://github.com/StoXProject/StoX/releases/tag/v4.1.1). For Windows download the .msi file, for MacOS download the .dmg file and for Linux download the .rpm or .deb file. Then follow the instructions below:

### Windows:

Expand Down
2 changes: 1 addition & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "stox",
"version": "4.1.0",
"version": "4.1.1",
"scripts": {
"ng": "ng",
"start": "ng serve",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "StoX",
"productName": "StoX",
"version": "4.1.0",
"version": "4.1.1",
"description": "StoX: An open source software for marine survey analyses",
"main": "build/index.js",
"scripts": {
Expand Down
4 changes: 3 additions & 1 deletion srv/OfficialRstoxFrameworkVersions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,6 @@ StoX RstoxFramework Dependencies OptionalDependencies Official Date
4.0.1-9003 4.0.1-9004 RstoxBase_2.0.1-9004,RstoxData_2.0.1-9005 RstoxFDA_1.3.0-9003 FALSE 2024-10-29
4.0.1-9004 4.0.1-9005 RstoxBase_2.0.1-9005,RstoxData_2.0.1-9007 RstoxFDA_1.3.0-9003 FALSE 2024-11-01
4.0.1-9005 4.0.1-9006 RstoxBase_2.0.1-9005,RstoxData_2.0.1-9007 RstoxFDA_1.3.0-9003 FALSE 2024-11-03
4.1.0 4.1.0 RstoxBase_2.1.0,RstoxData_2.1.0 RstoxFDA_1.3.0-9003 TRUE 2024-11-04
4.1.0 4.1.0 RstoxBase_2.1.0,RstoxData_2.1.0 RstoxFDA_1.3.0-9003 TRUE 2024-11-07
4.1.1-9001 4.1.1-9003 RstoxBase_2.1.1-9001,RstoxData_2.1.1-9001 RstoxFDA_1.5.0-9002 FALSE 2024-12-19
4.1.1 4.1.1 RstoxBase_2.1.1,RstoxData_2.1.1 RstoxFDA_1.3.0 TRUE 2024-12-20
1 change: 1 addition & 0 deletions srv/Official_StoX_versions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@
3.6.2
4.0.0
4.1.0
4.1.1
Loading