Skip to contents

Compute the Proportion of Dual Solutions in MUSIC Data

Source: R/SeaSondeRCS_MUSIC.R
seasonder_MUSICComputePropDualSols.Rd

This function calculates the proportion of "dual" solutions in the MUSIC data associated with a given SeaSondeRCS object. It updates the object with the computed proportion as a new attribute.

Usage

seasonder_MUSICComputePropDualSols(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing MUSIC data and other related attributes.

Value

A SeaSondeRCS object with the calculated proportion of "dual" solutions stored as an attribute. This attribute can be accessed using a relevant getter function.

Details

The function performs the following steps:

  1. Extracts the MUSIC data from the provided SeaSondeRCS object.

  2. Computes the proportion of entries in the retained_solution column of the MUSIC data that are labeled as "dual".

  3. Updates the SeaSondeRCS object by adding the computed proportion as an attribute using seasonder_setSeaSondeRCS_MUSIC_dual_solutions_proportion.

See also

seasonder_getSeaSondeRCS_MUSIC to retrieve the MUSIC data. seasonder_setSeaSondeRCS_MUSIC_dual_solutions_proportion to set the computed proportion.