Skip to content
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

fims::Vector operators and implicit scalar conversion #602

Closed
wants to merge 23 commits into from

Commits on May 14, 2024

  1. refactor (*.R): Adhere to tidyverse principals

    by cleaning up the R code
    
    Removes functions
    * mkObj
    * create_rcpp_interface_object
    * use_module
    * %>%
    * FIMSFrameAge
    
    Adds importFrom(TMB, MakeADFun) to package b/c TMB is no longer
    explicitly used in the codebase. And, experimented with removing usethis
    b/c it was also used in ./R/ but is still used in data-raw. It is now a
    suggested package. Uses :: instead of importing functions, e.g.,
    utils::head().
    
    * Constricts line width to 80 characters
    * Use full stops at the end of sentences
    * Implement more spacing in between roxygen tags
    * Move export tag to the end in most instances
    * Use explicit brackets for if statements
    * Remove duplicated code in gtest by calling run_gtest()
    * Parameter and object names to snake_case
    * Parameter, function, and object names, largely, w/o abbreviations
    
    fix(run_gtest): Use paste() instead of paste0() to ensure proper spacing
    which is not explicit in the instructions. With paste()
    they can input as many additional arguments as they want and they are
    all automatically separated, e.g.,
    `run_gtest("--something", "--something-else")`
    
    Close #588
    Close #564
    Close #590
    MOshima-PIFSC authored and kellijohnson-NOAA committed May 14, 2024
    Configuration menu
    Copy the full SHA
    2431f59 View commit details
    Browse the repository at this point in the history

Commits on May 20, 2024

  1. Configuration menu
    Copy the full SHA
    288a6ac View commit details
    Browse the repository at this point in the history

Commits on May 29, 2024

  1. doc: document units in FIMS (#591)

    - document units in code snippets of the fims-demo vignette
    - add units to output figures in the fims-demo vignette and add a spawning biomass comparison figure
    - add an R test to confirm that age composition intput can be in numbers or proportions
    - add units for index_data and age_data in data_mile1.R
    
    Co-authored-by: Kelli Johnson <kelli.johnson@noaa.gov>
    Bai-Li-NOAA and kellijohnson-NOAA authored May 29, 2024
    Configuration menu
    Copy the full SHA
    37e659c View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    9f13e8d View commit details
    Browse the repository at this point in the history

Commits on May 31, 2024

  1. Fix codecov (addresses #605)

    This is necessary because changes were made to
    codecov.io so that a token is required to upload.
    k-doering-NOAA committed May 31, 2024
    Configuration menu
    Copy the full SHA
    93c2625 View commit details
    Browse the repository at this point in the history

Commits on Jun 4, 2024

  1. Configuration menu
    Copy the full SHA
    5c3aee3 View commit details
    Browse the repository at this point in the history

Commits on Jun 5, 2024

  1. Configuration menu
    Copy the full SHA
    e12e353 View commit details
    Browse the repository at this point in the history

Commits on Jun 12, 2024

  1. Configuration menu
    Copy the full SHA
    4539fc4 View commit details
    Browse the repository at this point in the history

Commits on Jun 17, 2024

  1. doc: add documentation tabset and organize vignettes

    - post documentation for users, developers, and project managers
    - reorganize vignettes under appropriate sectionss
    - remove the navbar for articles to ensure no articles are hidden
    Bai-Li-NOAA committed Jun 17, 2024
    Configuration menu
    Copy the full SHA
    801542b View commit details
    Browse the repository at this point in the history

Commits on Jun 18, 2024

  1. fix(bug_report): correct triage label and reprex

    * Fixes the triage label to "status: triage_needed"
    * Adds text on where to find documentation of reprex and that you should
      use one. Copied from the dplyr issue template.
    
    Close NOAA-FIMS/collaborative_workflow#136
    kellijohnson-NOAA committed Jun 18, 2024
    Configuration menu
    Copy the full SHA
    73405dd View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ceef4b9 View commit details
    Browse the repository at this point in the history
  3. fix: Use native pipe instead of %>%

    We no longer import the magrittr pipe
    kellijohnson-NOAA committed Jun 18, 2024
    Configuration menu
    Copy the full SHA
    f939fc0 View commit details
    Browse the repository at this point in the history

Commits on Jun 20, 2024

  1. fix(data_mile1): sd of log(x) instead of CV

    For catch and index data the measurement of uncertainty should be the
    standard deviation (sd) of the logged observations. The operating model
    outputs a CV. I added a temporary function in data_mile1.R to calculate
    the sd from the CV. In the future we will need to, behind the scenes,
    take the log of the sd so the parameters stay within the bounds, which
    is what the vignette is doing now. This time series of uncertainty can
    later be fed to the modules but I did not change the vignette.
    
    Close #136
    kellijohnson-NOAA committed Jun 20, 2024
    Configuration menu
    Copy the full SHA
    2c16ff4 View commit details
    Browse the repository at this point in the history

Commits on Jun 21, 2024

  1. doc: Update install instructions on readme

    For users and developers, where the information for the latter was
    moved to the collaborative workflow see
    NOAA-FIMS/collaborative_workflow#146.
    
    A badge for R-universe was placed in the list of all badges!
    
    Work was done by @k-doering-NOAA with suggestions by @kellijohnson-NOAA
    
    Part of NOAA-FIMS/collaborative_workflow#98
    k-doering-NOAA authored and kellijohnson-NOAA committed Jun 21, 2024
    Configuration menu
    Copy the full SHA
    f071a64 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2024

  1. Configuration menu
    Copy the full SHA
    0296e41 View commit details
    Browse the repository at this point in the history

Commits on Jul 8, 2024

  1. refactor: Deletes issue and PR templates

    They have been moved and updated in NOAA-FIMS/.github/.github
    with NOAA-FIMS/.github@33c261d. Now they are available to all repositories
    not just NOAA-FIMS/FIMS. I did not migrate over the refactor_request
    issue template because it was largely redundant with the developer_other_issue
    template and I thought it was not needed.
    Kelli.Johnson authored and kellijohnson-NOAA committed Jul 8, 2024
    Configuration menu
    Copy the full SHA
    8f1a96e View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ecd2d80 View commit details
    Browse the repository at this point in the history

Commits on Jul 9, 2024

  1. test: add an R test to run FIMS in parallel with {snowfall}

    Co-authored-by: Cole-Monnahan-NOAA <Cole-Monnahan-NOAA@users.noreply.github.com>
    Bai-Li-NOAA and Cole-Monnahan-NOAA committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    87c6608 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    8aacee0 View commit details
    Browse the repository at this point in the history

Commits on Jul 12, 2024

  1. fix(FIMSFrame): Assume yyyy-mm-dd format for dates

    and check column names in FIMSFrame
    
    The column names of the S4@data object were being checked with the
    validation function but there was no check in FIMSFrame and to do the
    calculations within FIMSFrame all of the columns need to be present.
    Right now we are checking it twice, once in FIMSFrame and once in the
    validator of the FIMSFrame class. We might need a different class like an
    input data class and we could check the class upon input to FIMSFrame but
    this works for right now. @k-doering-NOAA do you have any ideas here?
    
    Had to change the test of a data frame without the proper columns to just
    error out because no warnings are given just a stop() command.
    
    When writing a data frame to a csv and reading it back in, the date
    formatting can be lost, e.g., 0001-01-01 turns into 1-1-1. FIMS requires
    a yyyy-mm-dd format. Now the use of the as.Date() function will create
    a date object from a character object but only if it is in the correct
    format. If it is in the wrong format, e.g., yyyy/mm/dd, then the function
    will error out.
    
    Right now the start_year and end_year are formatted as integers because for
    plotting, I thought it would be better to have year 1 versus year 0001 but
    we can change this. @ian-taylor-NOAA what do you think?
    
    Close #639 
    ---------
    
    Co-authored-by: Kelli.Johnson <1536491690113302@mil>
    kellijohnson-NOAA and Kelli.Johnson authored Jul 12, 2024
    Configuration menu
    Copy the full SHA
    39d0743 View commit details
    Browse the repository at this point in the history

Commits on Jul 26, 2024

  1. Configuration menu
    Copy the full SHA
    081972c View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    8b5ba1c View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    f0d4e76 View commit details
    Browse the repository at this point in the history