IDEMSInternational / epicsawrap

GNU Lesser General Public License v3.0
0 stars 0 forks source link

Adding package name #24

Closed lilyclements closed 1 year ago

lilyclements commented 1 year ago

Fixes #23

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (1a676ce) 0.00% compared to head (91bc336) 0.00%.

:exclamation: Current head 91bc336 differs from pull request most recent head f49ca11. Consider uploading reports for the commit f49ca11 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #24 +/- ## ===================================== Coverage 0.00% 0.00% ===================================== Files 9 9 Lines 236 236 ===================================== Misses 236 236 ``` | [Impacted Files](https://app.codecov.io/gh/IDEMSInternational/epicsawrap/pull/24?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=IDEMSInternational) | Coverage Δ | | |---|---|---| | [R/annual\_rainfall\_summaries.R](https://app.codecov.io/gh/IDEMSInternational/epicsawrap/pull/24?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=IDEMSInternational#diff-Ui9hbm51YWxfcmFpbmZhbGxfc3VtbWFyaWVzLlI=) | `0.00% <0.00%> (ø)` | | | [R/crop\_success\_probabilities.R](https://app.codecov.io/gh/IDEMSInternational/epicsawrap/pull/24?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=IDEMSInternational#diff-Ui9jcm9wX3N1Y2Nlc3NfcHJvYmFiaWxpdGllcy5S) | `0.00% <0.00%> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

lilyclements commented 1 year ago

@lloyddewit in terms of examples, I have some in the help file that will run if you remove the "#" symbol before them.

For this function we have six parameters

country,
station_id,
planting_dates = NULL,   - takes a list `c(...)` of numerics, e.g., `c(100, 150)`
water_requirements = NULL,   - takes a list `c(...)` of numerics, e.g., `c(100, 150)`
crop_length = NULL,   - takes a list `c(...)` of numerics, e.g., `c(100, 150)`
start_before_season = NULL   - takes `TRUE`, `FALSE`, or `NULL`. If you write `TRUE` or `FALSE`, you overwrite the value in the json file.

The bottom four can either be run by definitions in a json file which are read in, or they can be manually inputted. Or a mixture of both.

# just by json (because we have defined and saved it in a json file)
crop_success_probabilities(country = "zm", station_id = "16")

If we fill in these additional four parameters, we overwrite the value in the json file.

# All by json except for water_requirements which we define in the parameter code
crop_success_probabilities(country = "zm", station_id = "16", water_requirements = c(100, 300, 800))
# All defined in dialog
crop_success_probabilities(country = "zm", station_id = "16", water_requirements = c(100, 300, 800),
                           crop_length = c(100, 150), planting_dates = c(90, 100, 110))

Does this make sense?

lloyddewit commented 1 year ago

@thanks, I added new wrapper tests for all 6 parameters