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

Doc update v2.3.3 #117

Merged
merged 7 commits into from
Oct 3, 2023
Merged

Doc update v2.3.3 #117

merged 7 commits into from
Oct 3, 2023

Conversation

brownag
Copy link
Member

@brownag brownag commented Oct 1, 2023

This is an update to function definitions and corresponding documentation, brought to my attention by jblindsay/whitebox-tools#382

settings.json takes priority over default arguments in function definitions.

The default values for compress_rasters and verbose_mode have been set to NULL to better reflect this behavior. If the user specifies a value for these arguments in the function call then the flag will be passed in command line call. Otherwise the null value is ignored. Links to the corresponding option-setting functions have been added to the documentation to aid in setting up options

I have another development branch https://github.com/opengeos/whiteboxR/tree/wd4 that would implement some more general tools for reading/writing the settings.json file. Having control over this on the R side would potentially make it easier to keep R package options and Whitebox settings in sync

@codecov-commenter
Copy link

Codecov Report

Merging #117 (b6d6170) into master (1165485) will not change coverage.
The diff coverage is 100.00%.

❗ Current head b6d6170 differs from pull request most recent head 5711dae. Consider uploading reports for the commit 5711dae to get more accurate results

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@          Coverage Diff           @@
##           master    #117   +/-   ##
======================================
  Coverage    8.87%   8.87%           
======================================
  Files          21      21           
  Lines        8374    8374           
======================================
  Hits          743     743           
  Misses       7631    7631           
Files Coverage Δ
R/data_tools.R 0.00% <ø> (ø)
R/gis_analysis.R 0.00% <ø> (ø)
R/gis_analysis_distance.R 0.00% <ø> (ø)
R/gis_analysis_overlay.R 0.00% <ø> (ø)
R/gis_analysis_patch_shape.R 0.00% <ø> (ø)
R/hydro_analysis.R 0.00% <ø> (ø)
R/image_analysis.R 0.00% <ø> (ø)
R/image_analysis_classification.R 0.00% <ø> (ø)
R/image_analysis_enhancement.R 0.00% <ø> (ø)
R/image_analysis_filters.R 0.00% <ø> (ø)
... and 8 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@brownag brownag changed the title Doc update v2.3.x Doc update v2.3.3 Oct 3, 2023
@brownag brownag merged commit b637cc1 into master Oct 3, 2023
@brownag brownag deleted the doc-update-23x branch October 3, 2023 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants