Skip to content

NEWS.md

Latest commit

 

History

History
126 lines (116 loc) · 6.5 KB

NEWS.md

File metadata and controls

126 lines (116 loc) · 6.5 KB
Raw

HSestimate 2.0.0

Major changes & new features

  • Package renamed to HSestimate
    • In addition to checking Harvest Survey data, HSestimate will now also generate totals files and calculate harvest estimates.
  • Imports
    • Add {purrr}
    • Add {utils}
  • Introduced @family tags to function documentation to help navigate networks of helper functions and species groups. New tags include:
    • crane functions
    • dove functions
    • SCRG functions
    • waterfowl functions
    • woodcock functions
    • checking functions
      • daily data helpers - used across check.R, party.R, and convert.R
      • season data helpers - used across check.R and convert.R
      • error assigning functions - used across check.R and party.R
    • conversion functions
    • estimation functions
    • failure functions
    • party hunt functions
    • wrangling functions
  • Refactor checking functions in R/check.R
    • Create more internal helper functions and move most of the internal helpers back in to R/check.R; other files like R/errorIDs.R and R/overbag.R were deleted (see e6656cf).
    • Create surveyCheck() (previously named editCheck()), the exported checking function which runs internal functions depending on species group.
    • Internal helpers:
      • audit() and auditDV()
        • Create the list of daily corrected, daily audit, season corrected, and season audit tibbles.
        • Use recalculated and reassigned retrieved values changed by checking party hunts and converting sea duck and brant harvest.
      • checkWF() is used for waterfowl instead of a combination of surveyCheck() and audit(), since waterfowl must have SD and BR harvest converted to DK and GS, respectively, in a special step.
      • Check daily data
        • checkDailyWF() is used for waterfowl.
        • checkDailyDV() is used for doves.
        • checkDailySCRGWKCR() is used for snipe, coot, rails, gallinules, woodcock, and cranes.
      • Check season data
        • checkSeasonDV() is used for doves.
        • checkSeasonCR() is used for cranes.
        • checkSeasonWFSCRGWK() is used for waterfowl, snipe, coot, rails, gallinules, and woodcock.
      • Error checking
        • Daily
          • partyHuntFinder() assigns error1 (see R/party.R).
          • dailyOverBagWWMO() assigns error2 for doves.
          • dailyOverBagDKSD() assigns error2 for waterfowl.
          • dailyOverBag() assigns error3 for all species (including doves and waterfowl).
        • Season
          • naDaysHunted() assigns error1.
          • tooManyDaysHunted() assigns error2 for all species groups. It calculates the exact number of days allowed hunting for each state and species combination, even when different types of seasons (e.g., youth, veteran, regular, etc) overlap.
          • seasonOverBag() assigns error3 for all species groups except doves.
            • seasonOverBagDV() assigns error3 for doves.
          • seasonDNH() assigns error4.
    • Checking season data
      • Use checkSeasonWFSCRGWK() on waterfowl, snipe, coot, rail, gallinule, and woodcock.
      • Use checkSeasonCR() on cranes.
  • Add estimation functions to R/estimate.R, including:
    • speciesEstimate() runs internal helpers in the following order:
      • calcSumMeanVar() calculates the sum(), mean(), and var() across days_hunted, retrieved, unretrieved, active hunter, and successful hunter fields by state and estimation_stratum.
      • calcFreq() calculates the number of hunters by estimation_stratum.
      • calcAllStats() joins the sum, mean, variance, number of hunters by stratum, and species counts together.
      • calcVar() calculates multiple values using the product of calcAllStats(), such as: finite population correction factor, variance, total days hunted by stratum, total retrieved harvest by stratum, and total unretrieved harvest by stratum.
      • stateTotals() sums values calculated in calcVar() by state.
    • assignFlyway()
    • assignFlywaySDBR()
    • assignMgmtUnit()
    • hunterEstimates()
    • harvestEstimates()
    • stateSelect()
    • mgmtUnitSelect()
    • flywayTotals()
    • mgmtUnitTotals()
    • flywayFinal()
    • flywayFinalSDBR()
    • mgmtUnitFinal()
    • usFinal()
    • usFinalDV()
  • Modify internal failure functions in R/fails.R
    • Delete fails()
    • Create:
      • failtype() fails if type is not one of: 'Ducks', 'Geese', 'Brant', 'SeaDucks', 'MODO', 'WWDO', 'SACR', 'Woodcock', 'Snipe', 'Coots', 'Rails', 'Gallinules', 'BTPI'.
      • failStateCount() returns a message if the number of states in the season or daily data does not match the expected count.
      • failNARetrieved() fails if NA values are found in the retrieved field.
      • failNADaysHunted() fails if NA values are found in the days_hunted field.
      • failSurveyStates() fails if the list of states in the data being used to generate estimates is different from the standard list of expected states for that species group.
  • Update test-check.R
  • Added package startup message (see zzz.R)

Minor changes / bug fixes

  • Fixed bugs in convertWWDO()
    • dplyr::case_when() not compatible with using type in conditional statements, so moved errors_df creation.
  • Renamed variables.R to constants.R
    • Eliminate all REF_DAY_LIMIT_ internal reference objects.
    • Reordered and alphabetized vectors.
    • Added internal reference objects:
      • REF_STATES_ALL
      • REF_STATES_DK
      • REF_STATES_GS
      • REF_STATES_MODO
      • REF_STATES_WK
      • REF_STATES_COOTS
      • REF_STATES_RAILS
      • REF_STATES_GALLS
      • REF_STATES_BTPI
  • Added new variables.R for package versions and season assignment.
  • Rename state_numbers to REF_STATE_NUMBERS.

migbirdHS 1.0.1

  • Last version for migbirdHS

migbirdHS 1.0.0

  • Renamed to migbirdHS
  • Added a NEWS.md file to track changes to the package.
  • Edited proofHS() function to show additional informative decision-making columns in output.

migbirdMBHS 0.3.0

  • New updates for 2022-2023 HS data checks.
  • Overhaul of add_seaducks()
  • Removed correctHS()
  • Deprecated read_dhs()
  • Added internal function wrangle_ref() and used it to replace redundant code across multiple exported functions.
  • The %>% pipe was replaced with |> when possible.
  • Vignette updated.