Released August 15, 2018
oFile argument in getDataForAllScens() now defaults to NULL, so that this function conforms to CRAN policies regarding not writing to the user’s home file space by default. This should not cause any backwards compatability issues since all older code will explicitly specify the oFile argument.file argument in rwd_agg_template() is now empty, so the user must specify the file explicitly for it to be created, also to conform to the same CRAN policy.tempdir(), when necessary.Released June 8, 2018
rdf_to_rwtbl2(), was added to try and improve performance of rdf_aggregate(), and rw_scen_aggregate(). (#85) These functions were shown to be about 6x - 7x slower than getDataForAllScens() for the same aggregation. The new function calls a C++ version that creates the tbl_df, while maintaining the same information as rdf_to_rwtbl(). The API for the new function is slighly different; the first argument is now a path to an rdf file, rather than an already read in rdf object. Otherwise, the same options are available. The C++ version of rdf_to_twbl() is about 20x faster than the R version. However, rdf_aggregate(), and rw_scen_aggregate() are still about 4x slower than getDataForAllScens(), indicating that there is still some necesary work to get closer speeds between the two functions (#90). As part of this work, the following modifications to other functions were made:
rw_scen_aggregate() and rdf_aggregate() gain cpp arguments. By default, rdf_to_rwtbl2() is used, but rdf_to_rwtbl() can be foreced by setting cpp = FALSE.read_rdf() and read.rdf() gained an rdf argument. If TRUE (default), it returns an rdf object, otherwise it returns a character vector.rdf_to_rwtbl() in favor of rdf_to_rwtbl2()rdf_to_rwtbl(), scenario is coerced into a character. Typically this is a character, but it was previously left as numeric if specified as a numeric. For easier compatability with C++ and comparsion between rdf_to_rwtbl() and rdf_to_rwtbl2(), it’s now always a character.rdf_aggregate() and rw_scen_aggregate() gain a verbose parameter to print out the status of processing multiple scenarios, rdfs, and slots. (#82)rwd_agg_template()) to create a blank template (or with examples: examples = TRUE) csv file to use to create rwd_agg objects. (#78)read_rwd_agg()) to read in csv files as rwd_agg objects. (#70)read_rdf() error messages (#86)rw_scen_aggregate() will now work with unnamed scenarios and NULL scen_names arguments. (#81)rwslot_* functions now error if the data passed to them are not regular (January - December or October - September) (#83)
rdf_get_slot() now has a "timespan" attribute that corresponds to the start and end values of the rdf.rdf_aggregate() and rw_scen_aggregate(). Now it is clear that the Timestep columns is not returned. (#84)Released April 10, 2018
RWDataPlyr v0.6.0 includes a major revamping of how scenarios are processed and defines several new classes.
rw_scen_aggregate() and rdf_aggregate() added to upgrade existing getDataForAllScens() function, which processes multiple scenarios at a time. (#51)
rwd_agg class, which upgrades the exising “slot aggregation list”. The advantage of the new class is a much more flexible way to summarize and aggregate RiverWare slots. (#68)
rbind(), cbind(), as, and is.rwtbl_slot_names()), get the original scenario folders (rwtbl_get_scen_folder()), and get RiverWare slots names from the saved variable name (rwtbl_var_to_slot()) were added. (#50)getDataForAllScens() now always returns data invisibly, so the retFile arguement is deprecated. This function is also deprecated in favor of rw_scen_aggregate() and/or rdf_aggregate(). (#66)createSlotAggList() as a slot_agg_list class. Created applicable constructor, which deprecates createSlotAggList(). Includes print(), summary() and is./is_ methods and functions. (#67)
slot_agg_list objects work with the deprecated getDataForAllScens(), so rwd_agg objects are preferable.read_rw_csv() to read csv files created from RiverWare or RiverSMART. (#30)rdf_to_rwtbl() to convert rdf objects (read in from read.rdf()) to tibble objects. (#30)rdf class
read.rdf() now returns an object with an rdf classrdfSlotToMatrix().Switched to snake_case for all new functions and replaced existing functions with snake_case versions. (#76)
| Old Function | New Function |
|---|---|
getSlotsInRdf() |
rdf_slot_names() |
makeAllScenNames() |
rw_scen_gen_names() |
rdfSlotToMatrix() |
rdf_get_slot() |
sumMonth2Annual() |
rwslot_annual_sum() |
getTimeSpan() |
rdf_get_timespan() |
getWYFromYearmon() |
ym_get_wateryear() |
getMaxAnnValue() |
rwslot_annual_max() |
getMinAnnValue() |
rwslot_annual_min() |
flowWeightedAvgAnnConc() |
rwslot_fwaac() |
flowWeightedAvgAnnConc(), because it is rarely used it was converted to an internal function: trace_fwaac(). Then created rwslot_fwaac() that is exported and follows the input/output format of rwslot_annual_min() and rwslot_annual_max().Added the rwdataplyr-workflow vignette. Browse with vignette("rwdataplyr-workflow", package = "RWDataPlyr").
getDataForAllScens() will use full month name in the Month column. This change could break existing code if there are checks for particular months. (#20)slot_agg_list and getDataForAllScens(). (#14)read.rdf()’s original implementation. Now read.rdf2() (the faster implementation) is named read.rdf() and read.rdf2() is deprecated. (#63)
read.rdf() now works with rdf files that contain scalar slots (#52)read_rdf() is added as an alias.Released May 26, 2017
scales::percent, and keep us from having to multiply/divide by 100 if we compute other averages outside of RWDataPlyr. However, this will cause any plotting code that is expecting percentages between 0 and 100 instead of between 0 and 1 to break (or at least look weird). (#53)findAllSlots boolean parameter to getDataForAllScens()
TRUE an error will post if one or more of the slots cannot be found. If it is FALSE, then it will fill in the data frame with -99, but not fail. (#38)makeAllScenNames() will create scenario names for vectors of multiple dimensions.getWYFromYearmon() will take a yearmon object and determine the water year it falls into.WYMaxLTE as a valid aggregation method. This will compare the maximum value in a water year to a threshold and determine if it is less than or equal to the threshold.createSlotAggList() (#45)processSlots() (#42)getDataForAllScens() (and interal function processSlots()) work with rdf files that only include one trace of data (#40)getDataForAllScens() through processSlots() now returns the same type/class for Year and Variable columns for both annual and monthly data. Year is a numeric and Variable is always a character. This could affect code that does not read the data frame back in and assumes that Variable is a factor. (#54)createSlotAggList()RWDataPlyr:::processSlots()createSlotAggList(), so it will not wait until processSlots() is called to throw the error.