balance_ions_once function

Apply balance_ions function and output a dataframe

This function allows balance_ions to be added to a piped data frame. tidywater functions cannot be added after this function because they require a water class input.

balance_ions_once(df, input_water = "defined_water")

Arguments

• df: a data frame containing a water class column, which has already been computed using define_water_chain
• input_water: name of the column of water class data to be used as the input for this function. Default is "defined_water".

Returns

A dataframe with updated ions to balance water charge

Details

For large datasets, using fn_once or fn_chain may take many minutes to run. These types of functions use the furrr package for the option to use parallel processing and speed things up. To initialize parallel processing, use plan(multisession) or plan(multicore) (depending on your operating system) prior to your piped code with the fn_once or fn_chain functions. Note, parallel processing is best used when your code block takes more than a minute to run, shorter run times will not benefit from parallel processing.

Examples

library(purrr)
library(furrr)
library(tidyr)
library(dplyr)

example_df <- water_df %>%
  define_water_chain() %>%
  balance_ions_once()

example_df <- water_df %>%
  define_water_chain(output_water = "Different_defined_water_column") %>%
  balance_ions_once(input_water = "Different_defined_water_column")

# Initialize parallel processing
plan(multisession, workers = 2) # Remove the workers argument to use all available compute
example_df <- water_df %>%
  define_water_chain() %>%
  balance_ions_once()

# Optional: explicitly close multisession processing
plan(sequential)

See Also

balance_ions