├── .Rbuildignore ├── .codecov.yml ├── .github └── workflows │ ├── R-CMD-check.yaml │ ├── docker-publish.yml │ ├── pkgdown.yml │ └── test-coverage.yml ├── .gitignore ├── .pre-commit-config.yaml ├── CNAME ├── DESCRIPTION ├── Dockerfile ├── LICENSE ├── LICENSE.md ├── NAMESPACE ├── NEWS.md ├── PY2R ├── automation.py ├── blocks.txt ├── build_check.R ├── docs.txt ├── extract_functions.py ├── function_block.py ├── functions.txt ├── scripts │ ├── data_tools.R │ ├── gis_analysis.R │ ├── gis_analysis_distance.R │ ├── gis_analysis_overlay.R │ ├── gis_analysis_patch_shape.R │ ├── hydro_analysis.R │ ├── image_analysis.R │ ├── image_analysis_classification.R │ ├── image_analysis_enhancement.R │ ├── image_analysis_filters.R │ ├── lidar_analysis.R │ ├── machine_learning.R │ ├── math_stat_analysis.R │ ├── precision_agriculture.R │ ├── stream_network_analysis.R │ ├── terrain_analysis.R │ └── whitebox_utilities.R ├── tests │ ├── test-wbt_absolute_value.R │ ├── test-wbt_arc_cos.R │ ├── test-wbt_arc_sin.R │ ├── test-wbt_arc_tan.R │ ├── test-wbt_arcosh.R │ ├── test-wbt_arsinh.R │ ├── test-wbt_artanh.R │ ├── test-wbt_ceil.R │ ├── test-wbt_cos.R │ ├── test-wbt_cosh.R │ ├── test-wbt_cumulative_distribution.R │ ├── test-wbt_decrement.R │ ├── test-wbt_exp.R │ ├── test-wbt_exp2.R │ ├── test-wbt_floor.R │ ├── test-wbt_increment.R │ ├── test-wbt_is_no_data.R │ ├── test-wbt_ln.R │ ├── test-wbt_log10.R │ ├── test-wbt_log2.R │ ├── test-wbt_negate.R │ ├── test-wbt_quantiles.R │ ├── test-wbt_reciprocal.R │ ├── test-wbt_round.R │ ├── test-wbt_sin.R │ ├── test-wbt_sinh.R │ ├── test-wbt_square.R │ ├── test-wbt_square_root.R │ ├── test-wbt_tan.R │ ├── test-wbt_tanh.R │ ├── test-wbt_to_degrees.R │ ├── test-wbt_to_radians.R │ ├── test-wbt_truncate.R │ └── test-wbt_z_scores.R └── whitebox_tools.py ├── R ├── data_tools.R ├── gis_analysis.R ├── gis_analysis_distance.R ├── gis_analysis_overlay.R ├── gis_analysis_patch_shape.R ├── hydro_analysis.R ├── image_analysis.R ├── image_analysis_classification.R ├── image_analysis_enhancement.R ├── image_analysis_filters.R ├── lidar_analysis.R ├── machine_learning.R ├── math_stat_analysis.R ├── precision_agriculture.R ├── stream_network_analysis.R ├── terrain_analysis.R ├── wbt-method.R ├── wbt.R ├── wbt_source.R ├── whitebox-package.R ├── whitebox_utilities.R └── zzz.R ├── README.Rmd ├── README.md ├── _pkgdown.yml ├── appveyor.yml ├── cran-comments.md ├── data-raw ├── wbt_tools.R.bak ├── wbttools2.R ├── whitebox_ext.json └── whitebox_tools.json ├── data ├── wbttoolparameters.rda └── wbttools.rda ├── inst ├── CITATION ├── WORDLIST └── extdata │ ├── DEM.dep │ └── DEM.tif ├── man ├── check_whitebox_binary.Rd ├── figures │ └── README-terra-plot-facc-1.jpeg ├── install_whitebox.Rd ├── sample_dem_data.Rd ├── wbt.Rd ├── wbt_absolute_value.Rd ├── wbt_accumulation_curvature.Rd ├── wbt_activate.Rd ├── wbt_adaptive_filter.Rd ├── wbt_add.Rd ├── wbt_add_point_coordinates_to_table.Rd ├── wbt_aggregate_raster.Rd ├── wbt_and.Rd ├── wbt_anova.Rd ├── wbt_arc_cos.Rd ├── wbt_arc_sin.Rd ├── wbt_arc_tan.Rd ├── wbt_arcosh.Rd ├── wbt_arsinh.Rd ├── wbt_artanh.Rd ├── wbt_ascii_to_las.Rd ├── wbt_aspect.Rd ├── wbt_assess_route.Rd ├── wbt_atan2.Rd ├── wbt_attribute_correlation.Rd ├── wbt_attribute_correlation_neighbourhood_analysis.Rd ├── wbt_attribute_histogram.Rd ├── wbt_attribute_scattergram.Rd ├── wbt_average_flowpath_slope.Rd ├── wbt_average_normal_vector_angular_deviation.Rd ├── wbt_average_overlay.Rd ├── wbt_average_upslope_flowpath_length.Rd ├── wbt_balance_contrast_enhancement.Rd ├── wbt_basins.Rd ├── wbt_bilateral_filter.Rd ├── wbt_block_maximum_gridding.Rd ├── wbt_block_minimum_gridding.Rd ├── wbt_boundary_shape_complexity.Rd ├── wbt_breach_depressions.Rd ├── wbt_breach_depressions_least_cost.Rd ├── wbt_breach_single_cell_pits.Rd ├── wbt_breakline_mapping.Rd ├── wbt_buffer_raster.Rd ├── wbt_burn_streams_at_roads.Rd ├── wbt_canny_edge_detection.Rd ├── wbt_ceil.Rd ├── wbt_centroid.Rd ├── wbt_centroid_vector.Rd ├── wbt_change_vector_analysis.Rd ├── wbt_circular_variance_of_aspect.Rd ├── wbt_classify_buildings_in_lidar.Rd ├── wbt_classify_lidar.Rd ├── wbt_classify_overlap_points.Rd ├── wbt_clean_vector.Rd ├── wbt_clip.Rd ├── wbt_clip_lidar_to_polygon.Rd ├── wbt_clip_raster_to_polygon.Rd ├── wbt_closing.Rd ├── wbt_clump.Rd ├── wbt_colourize_based_on_class.Rd ├── wbt_colourize_based_on_point_returns.Rd ├── wbt_compactness_ratio.Rd ├── wbt_conditional_evaluation.Rd ├── wbt_conditioned_latin_hypercube.Rd ├── wbt_conservative_smoothing_filter.Rd ├── wbt_construct_vector_tin.Rd ├── wbt_contours_from_points.Rd ├── wbt_contours_from_raster.Rd ├── wbt_convert_nodata_to_zero.Rd ├── wbt_convert_raster_format.Rd ├── wbt_corner_detection.Rd ├── wbt_correct_vignetting.Rd ├── wbt_cos.Rd ├── wbt_cosh.Rd ├── wbt_cost_allocation.Rd ├── wbt_cost_distance.Rd ├── wbt_cost_pathway.Rd ├── wbt_count_if.Rd ├── wbt_create_colour_composite.Rd ├── wbt_create_hexagonal_vector_grid.Rd ├── wbt_create_plane.Rd ├── wbt_create_rectangular_vector_grid.Rd ├── wbt_crispness_index.Rd ├── wbt_cross_tabulation.Rd ├── wbt_csv_points_to_vector.Rd ├── wbt_cumulative_distribution.Rd ├── wbt_curvedness.Rd ├── wbt_d8_flow_accumulation.Rd ├── wbt_d8_mass_flux.Rd ├── wbt_d8_pointer.Rd ├── wbt_d_inf_flow_accumulation.Rd ├── wbt_d_inf_mass_flux.Rd ├── wbt_d_inf_pointer.Rd ├── wbt_dbscan.Rd ├── wbt_decrement.Rd ├── wbt_dem_void_filling.Rd ├── wbt_depth_in_sink.Rd ├── wbt_depth_to_water.Rd ├── wbt_dev_from_mean_elev.Rd ├── wbt_diff_from_mean_elev.Rd ├── wbt_diff_of_gaussian_filter.Rd ├── wbt_difference.Rd ├── wbt_difference_curvature.Rd ├── wbt_direct_decorrelation_stretch.Rd ├── wbt_directional_relief.Rd ├── wbt_dissolve.Rd ├── wbt_distance_to_outlet.Rd ├── wbt_diversity_filter.Rd ├── wbt_divide.Rd ├── wbt_downslope_distance_to_stream.Rd ├── wbt_downslope_flowpath_length.Rd ├── wbt_downslope_index.Rd ├── wbt_edge_contamination.Rd ├── wbt_edge_density.Rd ├── wbt_edge_preserving_mean_filter.Rd ├── wbt_edge_proportion.Rd ├── wbt_elev_above_pit.Rd ├── wbt_elev_percentile.Rd ├── wbt_elev_relative_to_min_max.Rd ├── wbt_elev_relative_to_watershed_min_max.Rd ├── wbt_elevation_above_stream.Rd ├── wbt_elevation_above_stream_euclidean.Rd ├── wbt_eliminate_coincident_points.Rd ├── wbt_elongation_ratio.Rd ├── wbt_embankment_mapping.Rd ├── wbt_emboss_filter.Rd ├── wbt_equal_to.Rd ├── wbt_erase.Rd ├── wbt_erase_polygon_from_lidar.Rd ├── wbt_erase_polygon_from_raster.Rd ├── wbt_euclidean_allocation.Rd ├── wbt_euclidean_distance.Rd ├── wbt_evaluate_training_sites.Rd ├── wbt_exp.Rd ├── wbt_exp2.Rd ├── wbt_export_table_to_csv.Rd ├── wbt_exposure_towards_wind_flux.Rd ├── wbt_extend_vector_lines.Rd ├── wbt_extract_nodes.Rd ├── wbt_extract_raster_values_at_points.Rd ├── wbt_extract_streams.Rd ├── wbt_extract_valleys.Rd ├── wbt_farthest_channel_head.Rd ├── wbt_fast_almost_gaussian_filter.Rd ├── wbt_fd8_flow_accumulation.Rd ├── wbt_fd8_pointer.Rd ├── wbt_feature_preserving_smoothing.Rd ├── wbt_fetch_analysis.Rd ├── wbt_file_path.Rd ├── wbt_fill_burn.Rd ├── wbt_fill_depressions.Rd ├── wbt_fill_depressions_planchon_and_darboux.Rd ├── wbt_fill_depressions_wang_and_liu.Rd ├── wbt_fill_missing_data.Rd ├── wbt_fill_single_cell_pits.Rd ├── wbt_filter_lidar.Rd ├── wbt_filter_lidar_classes.Rd ├── wbt_filter_lidar_scan_angles.Rd ├── wbt_filter_raster_features_by_area.Rd ├── wbt_find_flightline_edge_points.Rd ├── wbt_find_lowest_or_highest_points.Rd ├── wbt_find_main_stem.Rd ├── wbt_find_no_flow_cells.Rd ├── wbt_find_parallel_flow.Rd ├── wbt_find_patch_or_class_edge_cells.Rd ├── wbt_find_ridges.Rd ├── wbt_fix_dangling_arcs.Rd ├── wbt_flatten_lakes.Rd ├── wbt_flightline_overlap.Rd ├── wbt_flip_image.Rd ├── wbt_flood_order.Rd ├── wbt_floor.Rd ├── wbt_flow_accumulation_full_workflow.Rd ├── wbt_flow_length_diff.Rd ├── wbt_gamma_correction.Rd ├── wbt_gaussian_contrast_stretch.Rd ├── wbt_gaussian_curvature.Rd ├── wbt_gaussian_filter.Rd ├── wbt_gaussian_scale_space.Rd ├── wbt_generalize_classified_raster.Rd ├── wbt_generalize_with_similarity.Rd ├── wbt_generating_function.Rd ├── wbt_geomorphons.Rd ├── wbt_greater_than.Rd ├── wbt_hack_stream_order.Rd ├── wbt_heat_map.Rd ├── wbt_height_above_ground.Rd ├── wbt_help.Rd ├── wbt_high_pass_bilateral_filter.Rd ├── wbt_high_pass_filter.Rd ├── wbt_high_pass_median_filter.Rd ├── wbt_highest_position.Rd ├── wbt_hillshade.Rd ├── wbt_hillslopes.Rd ├── wbt_histogram_equalization.Rd ├── wbt_histogram_matching.Rd ├── wbt_histogram_matching_two_images.Rd ├── wbt_hole_proportion.Rd ├── wbt_horizon_angle.Rd ├── wbt_horizontal_excess_curvature.Rd ├── wbt_horton_stream_order.Rd ├── wbt_hydrologic_connectivity.Rd ├── wbt_hypsometric_analysis.Rd ├── wbt_hypsometrically_tinted_hillshade.Rd ├── wbt_idw_interpolation.Rd ├── wbt_ihs_to_rgb.Rd ├── wbt_image_autocorrelation.Rd ├── wbt_image_correlation.Rd ├── wbt_image_correlation_neighbourhood_analysis.Rd ├── wbt_image_regression.Rd ├── wbt_image_segmentation.Rd ├── wbt_image_slider.Rd ├── wbt_image_stack_profile.Rd ├── wbt_impoundment_size_index.Rd ├── wbt_in_place_add.Rd ├── wbt_in_place_divide.Rd ├── wbt_in_place_multiply.Rd ├── wbt_in_place_subtract.Rd ├── wbt_increment.Rd ├── wbt_individual_tree_detection.Rd ├── wbt_init.Rd ├── wbt_insert_dams.Rd ├── wbt_install_wb_extension.Rd ├── wbt_integer_division.Rd ├── wbt_integral_image.Rd ├── wbt_intersect.Rd ├── wbt_inverse_principal_component_analysis.Rd ├── wbt_is_no_data.Rd ├── wbt_isobasins.Rd ├── wbt_jenson_snap_pour_points.Rd ├── wbt_join_tables.Rd ├── wbt_k_means_clustering.Rd ├── wbt_k_nearest_mean_filter.Rd ├── wbt_kappa_index.Rd ├── wbt_knn_classification.Rd ├── wbt_knn_regression.Rd ├── wbt_ks_test_for_normality.Rd ├── wbt_laplacian_filter.Rd ├── wbt_laplacian_of_gaussian_filter.Rd ├── wbt_las_to_ascii.Rd ├── wbt_las_to_laz.Rd ├── wbt_las_to_multipoint_shapefile.Rd ├── wbt_las_to_shapefile.Rd ├── wbt_las_to_zlidar.Rd ├── wbt_launch_runner.Rd ├── wbt_launch_wb_runner.Rd ├── wbt_layer_footprint.Rd ├── wbt_laz_to_las.Rd ├── wbt_lee_sigma_filter.Rd ├── wbt_length_of_upstream_channels.Rd ├── wbt_less_than.Rd ├── wbt_license.Rd ├── wbt_lidar_block_maximum.Rd ├── wbt_lidar_block_minimum.Rd ├── wbt_lidar_classify_subset.Rd ├── wbt_lidar_colourize.Rd ├── wbt_lidar_contour.Rd ├── wbt_lidar_digital_surface_model.Rd ├── wbt_lidar_eigenvalue_features.Rd ├── wbt_lidar_elevation_slice.Rd ├── wbt_lidar_ground_point_filter.Rd ├── wbt_lidar_hex_binning.Rd ├── wbt_lidar_hillshade.Rd ├── wbt_lidar_histogram.Rd ├── wbt_lidar_idw_interpolation.Rd ├── wbt_lidar_info.Rd ├── wbt_lidar_join.Rd ├── wbt_lidar_kappa_index.Rd ├── wbt_lidar_nearest_neighbour_gridding.Rd ├── wbt_lidar_point_density.Rd ├── wbt_lidar_point_return_analysis.Rd ├── wbt_lidar_point_stats.Rd ├── wbt_lidar_ransac_planes.Rd ├── wbt_lidar_rbf_interpolation.Rd ├── wbt_lidar_remove_duplicates.Rd ├── wbt_lidar_remove_outliers.Rd ├── wbt_lidar_rooftop_analysis.Rd ├── wbt_lidar_segmentation.Rd ├── wbt_lidar_segmentation_based_filter.Rd ├── wbt_lidar_shift.Rd ├── wbt_lidar_sibson_interpolation.Rd ├── wbt_lidar_sort_by_time.Rd ├── wbt_lidar_thin.Rd ├── wbt_lidar_thin_high_density.Rd ├── wbt_lidar_tile.Rd ├── wbt_lidar_tile_footprint.Rd ├── wbt_lidar_tin_gridding.Rd ├── wbt_lidar_tophat_transform.Rd ├── wbt_line_detection_filter.Rd ├── wbt_line_intersections.Rd ├── wbt_line_thinning.Rd ├── wbt_linearity_index.Rd ├── wbt_lines_to_polygons.Rd ├── wbt_list_tools.Rd ├── wbt_list_unique_values.Rd ├── wbt_list_unique_values_raster.Rd ├── wbt_ln.Rd ├── wbt_local_hypsometric_analysis.Rd ├── wbt_local_quadratic_regression.Rd ├── wbt_log10.Rd ├── wbt_log2.Rd ├── wbt_logistic_regression.Rd ├── wbt_long_profile.Rd ├── wbt_long_profile_from_points.Rd ├── wbt_longest_flowpath.Rd ├── wbt_low_points_on_headwater_divides.Rd ├── wbt_lowest_position.Rd ├── wbt_majority_filter.Rd ├── wbt_map_off_terrain_objects.Rd ├── wbt_max.Rd ├── wbt_max_absolute_overlay.Rd ├── wbt_max_anisotropy_dev.Rd ├── wbt_max_anisotropy_dev_signature.Rd ├── wbt_max_branch_length.Rd ├── wbt_max_difference_from_mean.Rd ├── wbt_max_downslope_elev_change.Rd ├── wbt_max_elev_dev_signature.Rd ├── wbt_max_elevation_deviation.Rd ├── wbt_max_overlay.Rd ├── wbt_max_upslope_elev_change.Rd ├── wbt_max_upslope_flowpath_length.Rd ├── wbt_max_upslope_value.Rd ├── wbt_maximal_curvature.Rd ├── wbt_maximum_filter.Rd ├── wbt_md_inf_flow_accumulation.Rd ├── wbt_mean_curvature.Rd ├── wbt_mean_filter.Rd ├── wbt_median_filter.Rd ├── wbt_medoid.Rd ├── wbt_merge_line_segments.Rd ├── wbt_merge_table_with_csv.Rd ├── wbt_merge_vectors.Rd ├── wbt_min.Rd ├── wbt_min_absolute_overlay.Rd ├── wbt_min_dist_classification.Rd ├── wbt_min_downslope_elev_change.Rd ├── wbt_min_max_contrast_stretch.Rd ├── wbt_min_overlay.Rd ├── wbt_minimal_curvature.Rd ├── wbt_minimum_bounding_box.Rd ├── wbt_minimum_bounding_circle.Rd ├── wbt_minimum_bounding_envelope.Rd ├── wbt_minimum_convex_hull.Rd ├── wbt_minimum_filter.Rd ├── wbt_modified_k_means_clustering.Rd ├── wbt_modify_lidar.Rd ├── wbt_modify_no_data_value.Rd ├── wbt_modulo.Rd ├── wbt_mosaic.Rd ├── wbt_mosaic_with_feathering.Rd ├── wbt_multi_part_to_single_part.Rd ├── wbt_multidirectional_hillshade.Rd ├── wbt_multiply.Rd ├── wbt_multiply_overlay.Rd ├── wbt_multiscale_curvatures.Rd ├── wbt_multiscale_elevation_percentile.Rd ├── wbt_multiscale_roughness.Rd ├── wbt_multiscale_roughness_signature.Rd ├── wbt_multiscale_std_dev_normals.Rd ├── wbt_multiscale_std_dev_normals_signature.Rd ├── wbt_multiscale_topographic_position_image.Rd ├── wbt_narrowness_index.Rd ├── wbt_natural_neighbour_interpolation.Rd ├── wbt_nearest_neighbour_gridding.Rd ├── wbt_negate.Rd ├── wbt_new_raster_from_base.Rd ├── wbt_normal_vectors.Rd ├── wbt_normalize_lidar.Rd ├── wbt_normalized_difference_index.Rd ├── wbt_not.Rd ├── wbt_not_equal_to.Rd ├── wbt_num_downslope_neighbours.Rd ├── wbt_num_inflowing_neighbours.Rd ├── wbt_num_upslope_neighbours.Rd ├── wbt_olympic_filter.Rd ├── wbt_opening.Rd ├── wbt_openness.Rd ├── wbt_or.Rd ├── wbt_paired_sample_t_test.Rd ├── wbt_panchromatic_sharpening.Rd ├── wbt_parallelepiped_classification.Rd ├── wbt_patch_orientation.Rd ├── wbt_pennock_landform_class.Rd ├── wbt_percent_elev_range.Rd ├── wbt_percent_equal_to.Rd ├── wbt_percent_greater_than.Rd ├── wbt_percent_less_than.Rd ├── wbt_percentage_contrast_stretch.Rd ├── wbt_percentile_filter.Rd ├── wbt_perimeter_area_ratio.Rd ├── wbt_phi_coefficient.Rd ├── wbt_pick_from_list.Rd ├── wbt_piecewise_contrast_stretch.Rd ├── wbt_plan_curvature.Rd ├── wbt_polygon_area.Rd ├── wbt_polygon_long_axis.Rd ├── wbt_polygon_perimeter.Rd ├── wbt_polygon_short_axis.Rd ├── wbt_polygonize.Rd ├── wbt_polygons_to_lines.Rd ├── wbt_power.Rd ├── wbt_prewitt_filter.Rd ├── wbt_principal_component_analysis.Rd ├── wbt_print_geo_tiff_tags.Rd ├── wbt_profile.Rd ├── wbt_profile_curvature.Rd ├── wbt_qin_flow_accumulation.Rd ├── wbt_quantiles.Rd ├── wbt_quinn_flow_accumulation.Rd ├── wbt_radial_basis_function_interpolation.Rd ├── wbt_radius_of_gyration.Rd ├── wbt_raise_walls.Rd ├── wbt_random_field.Rd ├── wbt_random_forest_classification.Rd ├── wbt_random_forest_regression.Rd ├── wbt_random_sample.Rd ├── wbt_range_filter.Rd ├── wbt_raster_area.Rd ├── wbt_raster_calculator.Rd ├── wbt_raster_cell_assignment.Rd ├── wbt_raster_histogram.Rd ├── wbt_raster_perimeter.Rd ├── wbt_raster_streams_to_vector.Rd ├── wbt_raster_summary_stats.Rd ├── wbt_raster_to_vector_lines.Rd ├── wbt_raster_to_vector_points.Rd ├── wbt_raster_to_vector_polygons.Rd ├── wbt_rasterize_streams.Rd ├── wbt_reciprocal.Rd ├── wbt_reclass.Rd ├── wbt_reclass_equal_interval.Rd ├── wbt_reclass_from_file.Rd ├── wbt_reconcile_multiple_headers.Rd ├── wbt_recover_flightline_info.Rd ├── wbt_recreate_pass_lines.Rd ├── wbt_reinitialize_attribute_table.Rd ├── wbt_related_circumscribing_circle.Rd ├── wbt_relative_aspect.Rd ├── wbt_relative_topographic_position.Rd ├── wbt_remove_field_edge_points.Rd ├── wbt_remove_off_terrain_objects.Rd ├── wbt_remove_polygon_holes.Rd ├── wbt_remove_raster_polygon_holes.Rd ├── wbt_remove_short_streams.Rd ├── wbt_remove_spurs.Rd ├── wbt_repair_stream_vector_topology.Rd ├── wbt_resample.Rd ├── wbt_rescale_value_range.Rd ├── wbt_rgb_to_ihs.Rd ├── wbt_rho8_flow_accumulation.Rd ├── wbt_rho8_pointer.Rd ├── wbt_ring_curvature.Rd ├── wbt_river_centerlines.Rd ├── wbt_roberts_cross_filter.Rd ├── wbt_root_mean_square_error.Rd ├── wbt_rotor.Rd ├── wbt_round.Rd ├── wbt_ruggedness_index.Rd ├── wbt_run_tool.Rd ├── wbt_rust_backtrace.Rd ├── wbt_scharr_filter.Rd ├── wbt_sediment_transport_index.Rd ├── wbt_select_tiles_by_polygon.Rd ├── wbt_set_nodata_value.Rd ├── wbt_shadow_animation.Rd ├── wbt_shadow_image.Rd ├── wbt_shape_complexity_index.Rd ├── wbt_shape_complexity_index_raster.Rd ├── wbt_shape_index.Rd ├── wbt_shreve_stream_magnitude.Rd ├── wbt_sigmoidal_contrast_stretch.Rd ├── wbt_sin.Rd ├── wbt_single_part_to_multi_part.Rd ├── wbt_sinh.Rd ├── wbt_sink.Rd ├── wbt_slope.Rd ├── wbt_slope_vs_aspect_plot.Rd ├── wbt_slope_vs_elevation_plot.Rd ├── wbt_smooth_vectors.Rd ├── wbt_smooth_vegetation_residual.Rd ├── wbt_snap_pour_points.Rd ├── wbt_sobel_filter.Rd ├── wbt_sort_lidar.Rd ├── wbt_source.Rd ├── wbt_spherical_std_dev_of_normals.Rd ├── wbt_split_colour_composite.Rd ├── wbt_split_lidar.Rd ├── wbt_split_vector_lines.Rd ├── wbt_split_with_lines.Rd ├── wbt_square.Rd ├── wbt_square_root.Rd ├── wbt_standard_deviation_contrast_stretch.Rd ├── wbt_standard_deviation_filter.Rd ├── wbt_standard_deviation_of_slope.Rd ├── wbt_stochastic_depression_analysis.Rd ├── wbt_strahler_order_basins.Rd ├── wbt_strahler_stream_order.Rd ├── wbt_stream_link_class.Rd ├── wbt_stream_link_identifier.Rd ├── wbt_stream_link_length.Rd ├── wbt_stream_link_slope.Rd ├── wbt_stream_power_index.Rd ├── wbt_stream_slope_continuous.Rd ├── wbt_subbasins.Rd ├── wbt_subtract.Rd ├── wbt_sum_overlay.Rd ├── wbt_surface_area_ratio.Rd ├── wbt_svm_classification.Rd ├── wbt_svm_regression.Rd ├── wbt_symmetrical_difference.Rd ├── wbt_tan.Rd ├── wbt_tangential_curvature.Rd ├── wbt_tanh.Rd ├── wbt_thicken_raster_line.Rd ├── wbt_time_in_daylight.Rd ├── wbt_tin_gridding.Rd ├── wbt_to_degrees.Rd ├── wbt_to_radians.Rd ├── wbt_tool_help.Rd ├── wbt_tool_parameters.Rd ├── wbt_toolbox.Rd ├── wbt_tophat_transform.Rd ├── wbt_topo_render.Rd ├── wbt_topographic_position_animation.Rd ├── wbt_topological_stream_order.Rd ├── wbt_total_curvature.Rd ├── wbt_total_filter.Rd ├── wbt_trace_downslope_flowpaths.Rd ├── wbt_travelling_salesman_problem.Rd ├── wbt_trend_surface.Rd ├── wbt_trend_surface_vector_points.Rd ├── wbt_tributary_identifier.Rd ├── wbt_truncate.Rd ├── wbt_turning_bands_simulation.Rd ├── wbt_two_sample_ks_test.Rd ├── wbt_union.Rd ├── wbt_unnest_basins.Rd ├── wbt_unsharp_masking.Rd ├── wbt_unsphericity.Rd ├── wbt_update_nodata_cells.Rd ├── wbt_upslope_depression_storage.Rd ├── wbt_user_defined_weights_filter.Rd ├── wbt_vector_hex_binning.Rd ├── wbt_vector_lines_to_raster.Rd ├── wbt_vector_points_to_raster.Rd ├── wbt_vector_polygons_to_raster.Rd ├── wbt_vector_stream_network_analysis.Rd ├── wbt_version.Rd ├── wbt_vertical_excess_curvature.Rd ├── wbt_view_code.Rd ├── wbt_viewshed.Rd ├── wbt_visibility_index.Rd ├── wbt_voronoi_diagram.Rd ├── wbt_watershed.Rd ├── wbt_weighted_overlay.Rd ├── wbt_weighted_sum.Rd ├── wbt_wetness_index.Rd ├── wbt_wilcoxon_signed_rank_test.Rd ├── wbt_write_function_memory_insertion.Rd ├── wbt_xor.Rd ├── wbt_yield_filter.Rd ├── wbt_yield_map.Rd ├── wbt_yield_normalization.Rd ├── wbt_z_scores.Rd ├── wbt_zlidar_to_las.Rd ├── wbt_zonal_statistics.Rd ├── wbttoolparameters.Rd ├── wbttools.Rd └── whitebox-package.Rd ├── misc ├── custom_exe_path.R ├── introduce-wbt.md ├── run_tool_ex.R ├── sample_dem-crs.R ├── test_wbt_toolchains.R ├── twoargs.R └── wbt_source.R ├── tests ├── testthat.R └── testthat │ ├── test-toolchains.R │ ├── test-wbt.R │ ├── test-wbt_absolute_value.R │ ├── test-wbt_arc_cos.R │ ├── test-wbt_arc_sin.R │ ├── test-wbt_arc_tan.R │ ├── test-wbt_arcosh.R │ ├── test-wbt_arsinh.R │ ├── test-wbt_artanh.R │ ├── test-wbt_ceil.R │ ├── test-wbt_cos.R │ ├── test-wbt_cosh.R │ ├── test-wbt_cumulative_distribution.R │ ├── test-wbt_decrement.R │ ├── test-wbt_exp.R │ ├── test-wbt_exp2.R │ ├── test-wbt_floor.R │ ├── test-wbt_increment.R │ ├── test-wbt_is_no_data.R │ ├── test-wbt_ln.R │ ├── test-wbt_log10.R │ ├── test-wbt_log2.R │ ├── test-wbt_negate.R │ ├── test-wbt_quantiles.R │ ├── test-wbt_reciprocal.R │ ├── test-wbt_round.R │ ├── test-wbt_sin.R │ ├── test-wbt_sinh.R │ ├── test-wbt_square.R │ ├── test-wbt_square_root.R │ ├── test-wbt_tan.R │ ├── test-wbt_tanh.R │ ├── test-wbt_to_degrees.R │ ├── test-wbt_to_radians.R │ ├── test-wbt_truncate.R │ ├── test-wbt_z_scores.R │ └── test-whitebox-package.R └── vignettes ├── .gitignore ├── datasets.Rmd ├── demo.Rmd └── wbt-method.Rmd /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^CRAN-RELEASE$ 2 | ^CRAN-SUBMISSION$ 3 | ^CNAME$ 4 | ^Dockerfile$ 5 | ^appveyor\.yml$ 6 | ^\.codecov\.yml$ 7 | ^.*\.Rproj$ 8 | ^\.Rproj\.user$ 9 | ^README\.Rmd$ 10 | ^cran-comments\.md$ 11 | ^\.travis\.yml$ 12 | ^\.github$ 13 | ^WhiteboxTools_linux_amd64\.zip$ 14 | ^.*\.tif$ 15 | ^.*\.json$ 16 | ^doc$ 17 | ^Meta$ 18 | ^data-raw$ 19 | ^revdep$ 20 | ^_pkgdown\.yml$ 21 | ^\.pre-commit-config\.yaml$ 22 | WhiteboxTools_linux_amd64/ 23 | WBT/ 24 | CRAN/ 25 | PY2R/ 26 | binder/ 27 | docs/ 28 | misc/ 29 | .vscode/ 30 | ^LICENSE\.md$ 31 | -------------------------------------------------------------------------------- /.codecov.yml: -------------------------------------------------------------------------------- 1 | coverage: 2 | status: 3 | patch: 4 | default: 5 | target: 0% 6 | threshold: 1% 7 | branches: 8 | - main 9 | if_ci_failed: error 10 | -------------------------------------------------------------------------------- /.github/workflows/test-coverage.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | branches: 4 | - master 5 | pull_request: 6 | branches: 7 | - master 8 | 9 | name: test-coverage 10 | 11 | jobs: 12 | test-coverage: 13 | runs-on: macOS-latest 14 | env: 15 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 16 | R_WHITEBOX_EXE_PATH: '/Users/runner/Library/Application Support/org.R-project.R/R/whitebox/WBT/whitebox_tools ' 17 | 18 | steps: 19 | - uses: actions/checkout@v3 20 | 21 | - uses: r-lib/actions/setup-r@v2 22 | 23 | - uses: r-lib/actions/setup-pandoc@v2 24 | 25 | - name: Install system dependencies 26 | run: | 27 | brew install pkg-config 28 | brew install gdal 29 | 30 | - uses: r-lib/actions/setup-r-dependencies@v2 31 | with: 32 | extra-packages: any::rcmdcheck, any::covr, local::. 33 | needs: check 34 | 35 | - name: Install WhiteboxTools 36 | run: 37 | whitebox::install_whitebox() 38 | shell: Rscript {0} 39 | 40 | - name: Test coverage 41 | run: | 42 | covr::codecov() 43 | shell: Rscript {0} 44 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | inst/doc 2 | .Rproj.user 3 | .Rhistory 4 | .RData 5 | .Ruserdata 6 | WBT/ 7 | vignettes/*.tif 8 | vignettes/*.log 9 | whiteboxR.Rproj 10 | .vscode/ 11 | /doc/ 12 | /Meta/ 13 | /revdep/ 14 | *.zip 15 | *.shp 16 | *.shx 17 | *.prj 18 | *.dbf 19 | *.tif 20 | settings.json 21 | __MACOSX 22 | WhiteboxTools_linux_amd64 23 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/pre-commit-hooks 3 | rev: v5.0.0 4 | hooks: 5 | - id: check-yaml 6 | -------------------------------------------------------------------------------- /CNAME: -------------------------------------------------------------------------------- 1 | whiteboxR.gishub.org -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Reference: https://aboland.ie/Docker.html 2 | # Build Steps: 3 | 4 | # docker build -t opengeos/whiteboxR . 5 | # docker push giswqs/whiteboxr:latest 6 | # docker run -d -p 8787:8787 -e PASSWORD=mypassword -v ~/Documents:/home/rstudio/ opengeos/whiteboxr 7 | # Then open your web browser and navigate to `http://localhost:8787`. The default username is `rstudio` and the default password is `mypassword`. 8 | 9 | FROM rocker/rstudio:latest 10 | 11 | RUN apt-get update \ 12 | && apt-get install -y --no-install-recommends \ 13 | libxml2 \ 14 | git \ 15 | build-essential \ 16 | libproj-dev \ 17 | libgdal-dev \ 18 | libgeos-dev \ 19 | gdal-bin \ 20 | proj-bin \ 21 | libxt-dev \ 22 | libxml2-dev \ 23 | libsqlite3-dev \ 24 | libfribidi-dev \ 25 | libudunits2-dev 26 | 27 | RUN install2.r --error \ 28 | --deps TRUE \ 29 | devtools \ 30 | whitebox \ 31 | Rcpp \ 32 | Matrix \ 33 | terra \ 34 | sf \ 35 | ggplot2 \ 36 | tidyterra \ 37 | rmarkdown \ 38 | httr \ 39 | caTools \ 40 | rprojroot 41 | 42 | RUN Rscript -e "whitebox::install_whitebox()" 43 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | YEAR: 2024 2 | COPYRIGHT HOLDER: whitebox authors 3 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | # MIT License 2 | 3 | Copyright (c) 2024 whitebox authors 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /PY2R/build_check.R: -------------------------------------------------------------------------------- 1 | if (!require(devtools)) install.packages('devtools') 2 | if (!require(pkgdown)) install.packages('pkgdown') 3 | if (!require(rhub)) install.packages('rhub') 4 | if (!require(lintr)) install.packages('lintr') 5 | 6 | lintr::lint_package() 7 | 8 | devtools::check() 9 | # devtools::test() 10 | # rhub::check_for_cran() 11 | # 12 | # rhub::check_with_rdevel() 13 | # rhub::check_with_rpatched() 14 | # rhub::check_with_rrelease() 15 | # rhub::check_with_roldrel() 16 | # 17 | # rhub::check_on_windows() 18 | # 19 | # rhub::list_my_checks() 20 | 21 | pkgdown::build_site() 22 | # devtools::submit_cran() 23 | 24 | devtools::install_github("opengeos/whiteboxR") 25 | devtools::install_github("opengeos/whiteboxR@develop") 26 | -------------------------------------------------------------------------------- /PY2R/extract_functions.py: -------------------------------------------------------------------------------- 1 | import os 2 | dir_path = os.path.dirname(os.path.realpath(__file__)) 3 | wbt_py = os.path.join(dir_path, "whitebox_tools.py") 4 | 5 | ff = open(os.path.join(dir_path, "functions.txt"), "w") 6 | 7 | with open(wbt_py) as f: 8 | lines = f.readlines() 9 | for index, line in enumerate(lines): 10 | if index > 360: 11 | line = line.strip() 12 | if line.startswith("def"): 13 | print(line) 14 | line = line.replace("self, i,", "input,") 15 | line = line.replace("self, ", "") 16 | line = line.replace("callback=None", "verbose_mode=TRUE") 17 | line = line.replace("False", "FALSE") 18 | line = line.replace("True", "TRUE") 19 | line = line.replace("None", "NULL") 20 | line = line.replace("def ", "") 21 | line = line.replace(":", "") 22 | print(line) 23 | ff.write(line + "\n") 24 | 25 | ff.close() -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_absolute_value.R: -------------------------------------------------------------------------------- 1 | context("wbt_absolute_value") 2 | 3 | test_that("Calculates the absolute value of every cell in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_absolute_value(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_arc_cos.R: -------------------------------------------------------------------------------- 1 | context("wbt_arc_cos") 2 | 3 | test_that("Returns the inverse cosine (arccos) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arc_cos(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_arc_sin.R: -------------------------------------------------------------------------------- 1 | context("wbt_arc_sin") 2 | 3 | test_that("Returns the inverse sine (arcsin) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arc_sin(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_arc_tan.R: -------------------------------------------------------------------------------- 1 | context("wbt_arc_tan") 2 | 3 | test_that("Returns the inverse tangent (arctan) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arc_tan(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_arcosh.R: -------------------------------------------------------------------------------- 1 | context("wbt_arcosh") 2 | 3 | test_that("Returns the inverse hyperbolic cosine (arcosh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arcosh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_arsinh.R: -------------------------------------------------------------------------------- 1 | context("wbt_arsinh") 2 | 3 | test_that("Returns the inverse hyperbolic sine (arsinh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arsinh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_artanh.R: -------------------------------------------------------------------------------- 1 | context("wbt_artanh") 2 | 3 | test_that("Returns the inverse hyperbolic tangent (arctanh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_artanh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_ceil.R: -------------------------------------------------------------------------------- 1 | context("wbt_ceil") 2 | 3 | test_that("Returns the smallest (closest to negative infinity) value that is greater than or equal to the values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_ceil(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_cos.R: -------------------------------------------------------------------------------- 1 | context("wbt_cos") 2 | 3 | test_that("Returns the cosine (cos) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_cos(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_cosh.R: -------------------------------------------------------------------------------- 1 | context("wbt_cosh") 2 | 3 | test_that("Returns the hyperbolic cosine (cosh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_cosh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_cumulative_distribution.R: -------------------------------------------------------------------------------- 1 | context("wbt_cumulative_distribution") 2 | 3 | test_that("Converts a raster image to its cumulative distribution function", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_cumulative_distribution(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_decrement.R: -------------------------------------------------------------------------------- 1 | context("wbt_decrement") 2 | 3 | test_that("Decreases the values of each grid cell in an input raster by 10 (see also InPlaceSubtract)", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_decrement(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_exp.R: -------------------------------------------------------------------------------- 1 | context("wbt_exp") 2 | 3 | test_that("Returns the exponential (base e) of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_exp(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_exp2.R: -------------------------------------------------------------------------------- 1 | context("wbt_exp2") 2 | 3 | test_that("Returns the exponential (base 2) of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_exp2(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_floor.R: -------------------------------------------------------------------------------- 1 | context("wbt_floor") 2 | 3 | test_that("Returns the largest (closest to positive infinity) value that is less than or equal to the values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_floor(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_increment.R: -------------------------------------------------------------------------------- 1 | context("wbt_increment") 2 | 3 | test_that("Increases the values of each grid cell in an input raster by 10 (see also InPlaceAdd)", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_increment(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_is_no_data.R: -------------------------------------------------------------------------------- 1 | context("wbt_is_no_data") 2 | 3 | test_that("Identifies NoData valued pixels in an image", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_is_no_data(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_ln.R: -------------------------------------------------------------------------------- 1 | context("wbt_ln") 2 | 3 | test_that("Returns the natural logarithm of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_ln(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_log10.R: -------------------------------------------------------------------------------- 1 | context("wbt_log10") 2 | 3 | test_that("Returns the base-10 logarithm of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_log10(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_log2.R: -------------------------------------------------------------------------------- 1 | context("wbt_log2") 2 | 3 | test_that("Returns the base-2 logarithm of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_log2(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_negate.R: -------------------------------------------------------------------------------- 1 | context("wbt_negate") 2 | 3 | test_that("Changes the sign of values in a raster or the 0-1 values of a Boolean raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_negate(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_quantiles.R: -------------------------------------------------------------------------------- 1 | context("wbt_quantiles") 2 | 3 | test_that("Transforms raster values into quantiles", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_quantiles(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_reciprocal.R: -------------------------------------------------------------------------------- 1 | context("wbt_reciprocal") 2 | 3 | test_that("Returns the reciprocal (ie 1 / z) of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_reciprocal(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_round.R: -------------------------------------------------------------------------------- 1 | context("wbt_round") 2 | 3 | test_that("Rounds the values in an input raster to the nearest integer value", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_round(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_sin.R: -------------------------------------------------------------------------------- 1 | context("wbt_sin") 2 | 3 | test_that("Returns the sine (sin) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_sin(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_sinh.R: -------------------------------------------------------------------------------- 1 | context("wbt_sinh") 2 | 3 | test_that("Returns the hyperbolic sine (sinh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_sinh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_square.R: -------------------------------------------------------------------------------- 1 | context("wbt_square") 2 | 3 | test_that("Squares the values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_square(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_square_root.R: -------------------------------------------------------------------------------- 1 | context("wbt_square_root") 2 | 3 | test_that("Returns the square root of the values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_square_root(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_tan.R: -------------------------------------------------------------------------------- 1 | context("wbt_tan") 2 | 3 | test_that("Returns the tangent (tan) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_tan(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_tanh.R: -------------------------------------------------------------------------------- 1 | context("wbt_tanh") 2 | 3 | test_that("Returns the hyperbolic tangent (tanh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_tanh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_to_degrees.R: -------------------------------------------------------------------------------- 1 | context("wbt_to_degrees") 2 | 3 | test_that("Converts a raster from radians to degrees", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_to_degrees(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_to_radians.R: -------------------------------------------------------------------------------- 1 | context("wbt_to_radians") 2 | 3 | test_that("Converts a raster from degrees to radians", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_to_radians(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_truncate.R: -------------------------------------------------------------------------------- 1 | context("wbt_truncate") 2 | 3 | test_that("Truncates the values in a raster to the desired number of decimal places", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_truncate(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /PY2R/tests/test-wbt_z_scores.R: -------------------------------------------------------------------------------- 1 | context("wbt_z_scores") 2 | 3 | test_that("Standardizes the values in an input raster by converting to z-scores", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_z_scores(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | # DO NOT CHANGE the "init" and "install" sections below 2 | 3 | # Download script file from GitHub 4 | init: 5 | ps: | 6 | $ErrorActionPreference = "Stop" 7 | Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1" 8 | Import-Module '..\appveyor-tool.ps1' 9 | 10 | install: 11 | ps: Bootstrap 12 | 13 | cache: 14 | - C:\RLibrary 15 | 16 | # Adapt as necessary starting from here 17 | 18 | environment: 19 | global: 20 | USE_RTOOLS: true 21 | 22 | build_script: 23 | - travis-tool.sh install_deps 24 | 25 | test_script: 26 | - travis-tool.sh run_tests 27 | 28 | on_failure: 29 | - 7z a failure.zip *.Rcheck\* 30 | - appveyor PushArtifact failure.zip 31 | 32 | artifacts: 33 | - path: '*.Rcheck\**\*.log' 34 | name: Logs 35 | 36 | - path: '*.Rcheck\**\*.out' 37 | name: Logs 38 | 39 | - path: '*.Rcheck\**\*.fail' 40 | name: Logs 41 | 42 | - path: '*.Rcheck\**\*.Rout' 43 | name: Logs 44 | 45 | - path: '\*_*.tar.gz' 46 | name: Bits 47 | 48 | - path: '\*_*.zip' 49 | name: Bits 50 | -------------------------------------------------------------------------------- /cran-comments.md: -------------------------------------------------------------------------------- 1 | ## R CMD check results 2 | - GitHub actions (windows, macOS, ubuntu with R 4.4.0 + ubuntu with R-devel) 3 | - local check (manjaro linux R 4.4.0) 4 | - CRAN winbuilder (R-devel) 5 | - revdepcheck::revdep_check() 6 | 7 | 0 errors | 0 warnings | 0 notes 8 | -------------------------------------------------------------------------------- /data/wbttoolparameters.rda: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/opengeos/whiteboxR/4d2dae87df2decac27fbd2ef9833609c84c826a3/data/wbttoolparameters.rda -------------------------------------------------------------------------------- /data/wbttools.rda: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/opengeos/whiteboxR/4d2dae87df2decac27fbd2ef9833609c84c826a3/data/wbttools.rda -------------------------------------------------------------------------------- /inst/CITATION: -------------------------------------------------------------------------------- 1 | citHeader("To cite whitebox in publications use:") 2 | 3 | bibentry( 4 | bibtype = "Manual", 5 | title = "'whitebox': 'WhiteboxTools' R Frontend", 6 | author = "Qiusheng Wu, Andrew Brown", 7 | note = "R package version 2.2.0", 8 | url = "https://CRAN.R-project.org/package=whitebox", 9 | year = "2022", 10 | textVersion = "Wu, Q., Brown, A. (2022). whitebox: 'WhiteboxTools' R Frontend. R package version 2.2.0. " 11 | ) 12 | 13 | bibentry( 14 | bibtype = "Article", 15 | title = "Whitebox GAT: A case study in geomorphometric analysis.", 16 | author = "J. B. Lindsay", 17 | journal = "Computers & Geosciences", 18 | year = "2016", 19 | volume = "95", 20 | number = "", 21 | pages = "75-84", 22 | url = "http://dx.doi.org/10.1016/j.cageo.2016.07.003", 23 | textVersion = paste("Lindsay, J. B. (2016). Whitebox GAT: A case study in geomorphometric analysis. Computers & Geosciences, 95, 75-84. doi: http://dx.doi.org/10.1016/j.cageo.2016.07.003" 24 | ) 25 | ) 26 | -------------------------------------------------------------------------------- /inst/extdata/DEM.dep: -------------------------------------------------------------------------------- 1 | Min: 212.22877502441406 2 | Max: 1233.0966796875 3 | North: 4895782.5891085025 4 | South: 4878858.5400943495 5 | East: 686063.139196986 6 | West: 664737.0507251581 7 | Cols: 237 8 | Rows: 188 9 | Stacks: 1 10 | Data Type: FLOAT 11 | Z Units: not specified 12 | XY Units: metres 13 | Projection: not specified 14 | Data Scale: continuous 15 | Display Min: 212.22877502441406 16 | Display Max: 1233.0966796875 17 | Preferred Palette: high_relief.pal 18 | NoData: -32768.0 19 | Byte Order: LITTLE_ENDIAN 20 | Palette Nonlinearity: 1.0 21 | -------------------------------------------------------------------------------- /inst/extdata/DEM.tif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/opengeos/whiteboxR/4d2dae87df2decac27fbd2ef9833609c84c826a3/inst/extdata/DEM.tif -------------------------------------------------------------------------------- /man/check_whitebox_binary.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/zzz.R 3 | \name{check_whitebox_binary} 4 | \alias{check_whitebox_binary} 5 | \title{Check for 'WhiteboxTools' executable path} 6 | \usage{ 7 | check_whitebox_binary(silent = TRUE) 8 | } 9 | \arguments{ 10 | \item{silent}{logical. Print help on installation/setting path. Default \code{TRUE}.} 11 | } 12 | \value{ 13 | logical if 'WhiteboxTools' executable file exists. 14 | } 15 | \description{ 16 | Check for 'WhiteboxTools' executable path 17 | } 18 | \seealso{ 19 | \code{\link[=wbt_exe_path]{wbt_exe_path()}} 20 | } 21 | \keyword{General} 22 | -------------------------------------------------------------------------------- /man/figures/README-terra-plot-facc-1.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/opengeos/whiteboxR/4d2dae87df2decac27fbd2ef9833609c84c826a3/man/figures/README-terra-plot-facc-1.jpeg -------------------------------------------------------------------------------- /man/sample_dem_data.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{sample_dem_data} 4 | \alias{sample_dem_data} 5 | \title{Convenience method for path to sample DEM} 6 | \usage{ 7 | sample_dem_data( 8 | destfile = file.path(system.file("extdata", package = "whitebox"), "DEM.tif"), 9 | ... 10 | ) 11 | } 12 | \arguments{ 13 | \item{destfile}{Path to target location of sample data. Will be downloaded if does not exist. Defaults to file path of extdata subfolder of whitebox package installation directory.} 14 | 15 | \item{...}{additional arguments to download.file()} 16 | } 17 | \value{ 18 | character. 19 | } 20 | \description{ 21 | Get a file path to DEM.tif stored in extdata subfolder of whitebox package installation directory. If needed, download the TIFF file from GitHub. 22 | } 23 | \examples{ 24 | 25 | if (check_whitebox_binary()) { 26 | wbt_slope(sample_dem_data(), output = "slope.tif") 27 | } 28 | unlink(c('slope.tif', 'settings.json')) 29 | } 30 | \keyword{General} 31 | \keyword{datasets} 32 | -------------------------------------------------------------------------------- /man/wbt_absolute_value.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_absolute_value} 4 | \alias{wbt_absolute_value} 5 | \title{Absolute value} 6 | \usage{ 7 | wbt_absolute_value( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates the absolute value of every cell in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_activate.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_activate} 4 | \alias{wbt_activate} 5 | \title{Activate 'WhiteboxTools' Extensions} 6 | \usage{ 7 | wbt_activate( 8 | email, 9 | activation_key, 10 | seat = 1, 11 | destdir = dirname(wbt_exe_path(shell_quote = FALSE)) 12 | ) 13 | } 14 | \arguments{ 15 | \item{email}{Email Address} 16 | 17 | \item{activation_key}{Activation Key} 18 | 19 | \item{seat}{Seat Number (Default \code{1})} 20 | 21 | \item{destdir}{Directory containing \code{whitebox_tools} and \verb{/plugins/} folder.} 22 | } 23 | \value{ 24 | \code{0} for success (invisibly). Try-error on error. 25 | } 26 | \description{ 27 | Activate 'WhiteboxTools' Extensions 28 | } 29 | \keyword{General} 30 | -------------------------------------------------------------------------------- /man/wbt_add.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_add} 4 | \alias{wbt_add} 5 | \title{Add} 6 | \usage{ 7 | wbt_add( 8 | input1, 9 | input2, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{input1}{Input raster file or constant value.} 19 | 20 | \item{input2}{Input raster file or constant value.} 21 | 22 | \item{output}{Output raster file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Performs an addition operation on two rasters or a raster and a constant value. 37 | } 38 | \keyword{MathandStatsTools} 39 | -------------------------------------------------------------------------------- /man/wbt_add_point_coordinates_to_table.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_add_point_coordinates_to_table} 4 | \alias{wbt_add_point_coordinates_to_table} 5 | \title{Add point coordinates to table} 6 | \usage{ 7 | wbt_add_point_coordinates_to_table( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector Points file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Modifies the attribute table of a point vector by adding fields containing each point's X and Y coordinates. 31 | } 32 | \keyword{DataTools} 33 | -------------------------------------------------------------------------------- /man/wbt_arc_cos.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_arc_cos} 4 | \alias{wbt_arc_cos} 5 | \title{Arc cos} 6 | \usage{ 7 | wbt_arc_cos( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the inverse cosine (arccos) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_arc_sin.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_arc_sin} 4 | \alias{wbt_arc_sin} 5 | \title{Arc sin} 6 | \usage{ 7 | wbt_arc_sin( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the inverse sine (arcsin) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_arc_tan.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_arc_tan} 4 | \alias{wbt_arc_tan} 5 | \title{Arc tan} 6 | \usage{ 7 | wbt_arc_tan( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the inverse tangent (arctan) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_arcosh.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_arcosh} 4 | \alias{wbt_arcosh} 5 | \title{Arcosh} 6 | \usage{ 7 | wbt_arcosh( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the inverse hyperbolic cosine (arcosh) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_arsinh.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_arsinh} 4 | \alias{wbt_arsinh} 5 | \title{Arsinh} 6 | \usage{ 7 | wbt_arsinh( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the inverse hyperbolic sine (arsinh) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_artanh.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_artanh} 4 | \alias{wbt_artanh} 5 | \title{Artanh} 6 | \usage{ 7 | wbt_artanh( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the inverse hyperbolic tangent (arctanh) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_aspect.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/terrain_analysis.R 3 | \name{wbt_aspect} 4 | \alias{wbt_aspect} 5 | \title{Aspect} 6 | \usage{ 7 | wbt_aspect( 8 | dem, 9 | output, 10 | zfactor = NULL, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{dem}{Input raster DEM file.} 19 | 20 | \item{output}{Output raster file.} 21 | 22 | \item{zfactor}{Optional multiplier for when the vertical and horizontal units are not the same.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Calculates an aspect raster from an input DEM. 37 | } 38 | \keyword{GeomorphometricAnalysis} 39 | -------------------------------------------------------------------------------- /man/wbt_atan2.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_atan2} 4 | \alias{wbt_atan2} 5 | \title{Atan2} 6 | \usage{ 7 | wbt_atan2( 8 | input_y, 9 | input_x, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{input_y}{Input y raster file or constant value (rise).} 19 | 20 | \item{input_x}{Input x raster file or constant value (run).} 21 | 22 | \item{output}{Output raster file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Returns the 2-argument inverse tangent (atan2). 37 | } 38 | \keyword{MathandStatsTools} 39 | -------------------------------------------------------------------------------- /man/wbt_average_flowpath_slope.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_average_flowpath_slope} 4 | \alias{wbt_average_flowpath_slope} 5 | \title{Average flowpath slope} 6 | \usage{ 7 | wbt_average_flowpath_slope( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Measures the average slope gradient from each grid cell to all upslope divide cells. 34 | } 35 | \keyword{HydrologicalAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_basins.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_basins} 4 | \alias{wbt_basins} 5 | \title{Basins} 6 | \usage{ 7 | wbt_basins( 8 | d8_pntr, 9 | output, 10 | esri_pntr = FALSE, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{d8_pntr}{Input raster D8 pointer file.} 19 | 20 | \item{output}{Output raster file.} 21 | 22 | \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Identifies drainage basins that drain to the DEM edge. 37 | } 38 | \keyword{HydrologicalAnalysis} 39 | -------------------------------------------------------------------------------- /man/wbt_breach_single_cell_pits.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_breach_single_cell_pits} 4 | \alias{wbt_breach_single_cell_pits} 5 | \title{Breach single cell pits} 6 | \usage{ 7 | wbt_breach_single_cell_pits( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Removes single-cell pits from an input DEM by breaching. 34 | } 35 | \keyword{HydrologicalAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_ceil.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_ceil} 4 | \alias{wbt_ceil} 5 | \title{Ceil} 6 | \usage{ 7 | wbt_ceil( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the smallest (closest to negative infinity) value that is greater than or equal to the values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_centroid_vector.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_centroid_vector} 4 | \alias{wbt_centroid_vector} 5 | \title{Centroid vector} 6 | \usage{ 7 | wbt_centroid_vector( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output vector file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Identifies the centroid point of a vector polyline or polygon feature or a group of vector points. 34 | } 35 | \keyword{GISAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_clean_vector.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_clean_vector} 4 | \alias{wbt_clean_vector} 5 | \title{Clean vector} 6 | \usage{ 7 | wbt_clean_vector( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output vector file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Removes null features and lines/polygons with fewer than the required number of vertices. 34 | } 35 | \keyword{DataTools} 36 | -------------------------------------------------------------------------------- /man/wbt_compactness_ratio.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_compactness_ratio} 4 | \alias{wbt_compactness_ratio} 5 | \title{Compactness ratio} 6 | \usage{ 7 | wbt_compactness_ratio( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the compactness ratio (A/P), a measure of shape complexity, for vector polygons. 31 | } 32 | \keyword{GISAnalysisPatchShapeTools} 33 | -------------------------------------------------------------------------------- /man/wbt_convert_nodata_to_zero.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_convert_nodata_to_zero} 4 | \alias{wbt_convert_nodata_to_zero} 5 | \title{Convert nodata to zero} 6 | \usage{ 7 | wbt_convert_nodata_to_zero( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Converts nodata values in a raster to zero. 34 | } 35 | \keyword{DataTools} 36 | -------------------------------------------------------------------------------- /man/wbt_convert_raster_format.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_convert_raster_format} 4 | \alias{wbt_convert_raster_format} 5 | \title{Convert raster format} 6 | \usage{ 7 | wbt_convert_raster_format( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Converts raster data from one format to another. 34 | } 35 | \keyword{DataTools} 36 | -------------------------------------------------------------------------------- /man/wbt_corner_detection.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/image_analysis_filters.R 3 | \name{wbt_corner_detection} 4 | \alias{wbt_corner_detection} 5 | \title{Corner detection} 6 | \usage{ 7 | wbt_corner_detection( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input boolean image.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Identifies corner patterns in boolean images using hit-and-miss pattern matching. 34 | } 35 | \keyword{ImageProcessingToolsFilters} 36 | -------------------------------------------------------------------------------- /man/wbt_cos.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_cos} 4 | \alias{wbt_cos} 5 | \title{Cos} 6 | \usage{ 7 | wbt_cos( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the cosine (cos) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_cosh.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_cosh} 4 | \alias{wbt_cosh} 5 | \title{Cosh} 6 | \usage{ 7 | wbt_cosh( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the hyperbolic cosine (cosh) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_d8_pointer.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_d8_pointer} 4 | \alias{wbt_d8_pointer} 5 | \title{D8 pointer} 6 | \usage{ 7 | wbt_d8_pointer( 8 | dem, 9 | output, 10 | esri_pntr = FALSE, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{dem}{Input raster DEM file.} 19 | 20 | \item{output}{Output raster file.} 21 | 22 | \item{esri_pntr}{D8 pointer uses the ESRI style scheme.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Calculates a D8 flow pointer raster from an input DEM. 37 | } 38 | \keyword{HydrologicalAnalysis} 39 | -------------------------------------------------------------------------------- /man/wbt_d_inf_pointer.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_d_inf_pointer} 4 | \alias{wbt_d_inf_pointer} 5 | \title{D inf pointer} 6 | \usage{ 7 | wbt_d_inf_pointer( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates a D-infinity flow pointer (flow direction) raster from an input DEM. 34 | } 35 | \keyword{HydrologicalAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_decrement.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_decrement} 4 | \alias{wbt_decrement} 5 | \title{Decrement} 6 | \usage{ 7 | wbt_decrement( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Decreases the values of each grid cell in an input raster by 1.0 (see also InPlaceSubtract). 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_divide.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_divide} 4 | \alias{wbt_divide} 5 | \title{Divide} 6 | \usage{ 7 | wbt_divide( 8 | input1, 9 | input2, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{input1}{Input raster file or constant value.} 19 | 20 | \item{input2}{Input raster file or constant value.} 21 | 22 | \item{output}{Output raster file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Performs a division operation on two rasters or a raster and a constant value. 37 | } 38 | \keyword{MathandStatsTools} 39 | -------------------------------------------------------------------------------- /man/wbt_elev_above_pit.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/terrain_analysis.R 3 | \name{wbt_elev_above_pit} 4 | \alias{wbt_elev_above_pit} 5 | \title{Elev above pit} 6 | \usage{ 7 | wbt_elev_above_pit( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculate the elevation of each grid cell above the nearest downstream pit cell or grid edge cell. 34 | } 35 | \keyword{GeomorphometricAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_elongation_ratio.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_elongation_ratio} 4 | \alias{wbt_elongation_ratio} 5 | \title{Elongation ratio} 6 | \usage{ 7 | wbt_elongation_ratio( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the elongation ratio for vector polygons. 31 | } 32 | \keyword{GISAnalysisPatchShapeTools} 33 | -------------------------------------------------------------------------------- /man/wbt_euclidean_distance.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_distance.R 3 | \name{wbt_euclidean_distance} 4 | \alias{wbt_euclidean_distance} 5 | \title{Euclidean distance} 6 | \usage{ 7 | wbt_euclidean_distance( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates the Shih and Wu (2004) Euclidean distance transform. 34 | } 35 | \keyword{GISAnalysisDistanceTools} 36 | -------------------------------------------------------------------------------- /man/wbt_exp.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_exp} 4 | \alias{wbt_exp} 5 | \title{Exp} 6 | \usage{ 7 | wbt_exp( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the exponential (base e) of values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_exp2.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_exp2} 4 | \alias{wbt_exp2} 5 | \title{Exp2} 6 | \usage{ 7 | wbt_exp2( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the exponential (base 2) of values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_extract_nodes.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_extract_nodes} 4 | \alias{wbt_extract_nodes} 5 | \title{Extract nodes} 6 | \usage{ 7 | wbt_extract_nodes( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector lines or polygon file.} 18 | 19 | \item{output}{Output vector points file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Converts vector lines or polygons into vertex points. 34 | } 35 | \keyword{GISAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_fd8_pointer.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_fd8_pointer} 4 | \alias{wbt_fd8_pointer} 5 | \title{Fd8 pointer} 6 | \usage{ 7 | wbt_fd8_pointer( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates an FD8 flow pointer raster from an input DEM. 34 | } 35 | \keyword{HydrologicalAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_fill_burn.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_fill_burn} 4 | \alias{wbt_fill_burn} 5 | \title{Fill burn} 6 | \usage{ 7 | wbt_fill_burn( 8 | dem, 9 | streams, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{dem}{Input raster DEM file.} 19 | 20 | \item{streams}{Input vector streams file.} 21 | 22 | \item{output}{Output raster file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Burns streams into a DEM using the FillBurn (Saunders, 1999) method. 37 | } 38 | \keyword{HydrologicalAnalysis} 39 | -------------------------------------------------------------------------------- /man/wbt_fill_single_cell_pits.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_fill_single_cell_pits} 4 | \alias{wbt_fill_single_cell_pits} 5 | \title{Fill single cell pits} 6 | \usage{ 7 | wbt_fill_single_cell_pits( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Raises pit cells to the elevation of their lowest neighbour. 34 | } 35 | \keyword{HydrologicalAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_find_flightline_edge_points.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/lidar_analysis.R 3 | \name{wbt_find_flightline_edge_points} 4 | \alias{wbt_find_flightline_edge_points} 5 | \title{Find flightline edge points} 6 | \usage{ 7 | wbt_find_flightline_edge_points( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input LiDAR file.} 18 | 19 | \item{output}{Output file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Identifies points along a flightline's edge in a LAS file. 34 | } 35 | \keyword{LiDARTools} 36 | -------------------------------------------------------------------------------- /man/wbt_find_no_flow_cells.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_find_no_flow_cells} 4 | \alias{wbt_find_no_flow_cells} 5 | \title{Find no flow cells} 6 | \usage{ 7 | wbt_find_no_flow_cells( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Finds grid cells with no downslope neighbours. 34 | } 35 | \keyword{HydrologicalAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_flatten_lakes.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_flatten_lakes} 4 | \alias{wbt_flatten_lakes} 5 | \title{Flatten lakes} 6 | \usage{ 7 | wbt_flatten_lakes( 8 | dem, 9 | lakes, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{dem}{Input raster DEM file.} 19 | 20 | \item{lakes}{Input lakes vector polygons file.} 21 | 22 | \item{output}{Output raster file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Flattens lake polygons in a raster DEM. 37 | } 38 | \keyword{HydrologicalAnalysis} 39 | -------------------------------------------------------------------------------- /man/wbt_floor.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_floor} 4 | \alias{wbt_floor} 5 | \title{Floor} 6 | \usage{ 7 | wbt_floor( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the largest (closest to positive infinity) value that is less than or equal to the values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_help.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_help} 4 | \alias{wbt_help} 5 | \title{Help description for 'WhiteboxTools'} 6 | \usage{ 7 | wbt_help() 8 | } 9 | \value{ 10 | Returns the help description for 'WhiteboxTools' as an R character vector. 11 | } 12 | \description{ 13 | Help description for 'WhiteboxTools' 14 | } 15 | \examples{ 16 | \dontrun{ 17 | wbt_help() 18 | } 19 | } 20 | \keyword{General} 21 | -------------------------------------------------------------------------------- /man/wbt_hole_proportion.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_hole_proportion} 4 | \alias{wbt_hole_proportion} 5 | \title{Hole proportion} 6 | \usage{ 7 | wbt_hole_proportion( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the proportion of the total area of a polygon's holes relative to the area of the polygon's hull. 31 | } 32 | \keyword{GISAnalysisPatchShapeTools} 33 | -------------------------------------------------------------------------------- /man/wbt_in_place_add.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_in_place_add} 4 | \alias{wbt_in_place_add} 5 | \title{In place add} 6 | \usage{ 7 | wbt_in_place_add( 8 | input1, 9 | input2, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input1}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{input2}{Input raster file or constant value.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Performs an in-place addition operation (input1 += input2). 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_in_place_divide.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_in_place_divide} 4 | \alias{wbt_in_place_divide} 5 | \title{In place divide} 6 | \usage{ 7 | wbt_in_place_divide( 8 | input1, 9 | input2, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input1}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{input2}{Input raster file or constant value.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Performs an in-place division operation (input1 /= input2). 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_in_place_multiply.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_in_place_multiply} 4 | \alias{wbt_in_place_multiply} 5 | \title{In place multiply} 6 | \usage{ 7 | wbt_in_place_multiply( 8 | input1, 9 | input2, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input1}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{input2}{Input raster file or constant value.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Performs an in-place multiplication operation (input1 *= input2). 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_increment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_increment} 4 | \alias{wbt_increment} 5 | \title{Increment} 6 | \usage{ 7 | wbt_increment( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Increases the values of each grid cell in an input raster by 1.0. (see also InPlaceAdd). 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_integral_image.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/image_analysis.R 3 | \name{wbt_integral_image} 4 | \alias{wbt_integral_image} 5 | \title{Integral image} 6 | \usage{ 7 | wbt_integral_image( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Transforms an input image (summed area table) into its integral image equivalent. 34 | } 35 | \keyword{ImageProcessingTools} 36 | -------------------------------------------------------------------------------- /man/wbt_is_no_data.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_is_no_data} 4 | \alias{wbt_is_no_data} 5 | \title{Is no data} 6 | \usage{ 7 | wbt_is_no_data( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Identifies NoData valued pixels in an image. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_las_to_ascii.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/lidar_analysis.R 3 | \name{wbt_las_to_ascii} 4 | \alias{wbt_las_to_ascii} 5 | \title{Las to ascii} 6 | \usage{ 7 | wbt_las_to_ascii( 8 | inputs, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{inputs}{Input LiDAR files.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Converts one or more LAS files into ASCII text files. 31 | } 32 | \keyword{LiDARTools} 33 | -------------------------------------------------------------------------------- /man/wbt_las_to_laz.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/lidar_analysis.R 3 | \name{wbt_las_to_laz} 4 | \alias{wbt_las_to_laz} 5 | \title{Las to laz} 6 | \usage{ 7 | wbt_las_to_laz( 8 | input, 9 | output = NULL, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Name of the input LAS files (leave blank to use all LAS files in WorkingDirectory.} 18 | 19 | \item{output}{Output LAZ file (including extension).} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | This tool converts one or more LAS files into the LAZ format. 34 | } 35 | \keyword{LiDARTools} 36 | -------------------------------------------------------------------------------- /man/wbt_las_to_shapefile.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/lidar_analysis.R 3 | \name{wbt_las_to_shapefile} 4 | \alias{wbt_las_to_shapefile} 5 | \title{Las to shapefile} 6 | \usage{ 7 | wbt_las_to_shapefile( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input LiDAR file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Converts one or more LAS files into a vector Shapefile of POINT ShapeType. 31 | } 32 | \keyword{LiDARTools} 33 | -------------------------------------------------------------------------------- /man/wbt_launch_runner.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_launch_runner} 4 | \alias{wbt_launch_runner} 5 | \title{Launch 'WhiteboxTools Runner' GUI} 6 | \usage{ 7 | wbt_launch_runner(clear_app_state = FALSE) 8 | } 9 | \arguments{ 10 | \item{clear_app_state}{Clear application state memory? Default: \code{FALSE}} 11 | } 12 | \description{ 13 | \code{wbt_launch_runner()}: Launch the 'WhiteboxTools Runner' GUI at \code{wbt_runner_path()} 14 | } 15 | \details{ 16 | Opens the 'WhiteboxTools Runner' GUI included with WhiteboxTools Open Core v2.3.0 or higher. 17 | } 18 | \seealso{ 19 | \code{\link[=wbt_runner_path]{wbt_runner_path()}} 20 | } 21 | \keyword{General} 22 | -------------------------------------------------------------------------------- /man/wbt_launch_wb_runner.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/whitebox_utilities.R 3 | \name{wbt_launch_wb_runner} 4 | \alias{wbt_launch_wb_runner} 5 | \title{Launch wb runner} 6 | \usage{ 7 | wbt_launch_wb_runner( 8 | clear_app_state = FALSE, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{clear_app_state}{Clear the application state memory?.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Opens the Whitebox Runner application. 31 | } 32 | \keyword{WhiteboxUtilities} 33 | -------------------------------------------------------------------------------- /man/wbt_layer_footprint.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_layer_footprint} 4 | \alias{wbt_layer_footprint} 5 | \title{Layer footprint} 6 | \usage{ 7 | wbt_layer_footprint( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster or vector file.} 18 | 19 | \item{output}{Output vector polygon file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Creates a vector polygon footprint of the area covered by a raster grid or vector layer. 34 | } 35 | \keyword{GISAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_laz_to_las.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/lidar_analysis.R 3 | \name{wbt_laz_to_las} 4 | \alias{wbt_laz_to_las} 5 | \title{Laz to las} 6 | \usage{ 7 | wbt_laz_to_las( 8 | input, 9 | output = NULL, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Name of the input LAZ files (leave blank to use all LAZ files in WorkingDirectory.} 18 | 19 | \item{output}{Output LAS file (including extension).} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | This tool converts one or more LAZ files into the LAS format. 34 | } 35 | \keyword{LiDARTools} 36 | -------------------------------------------------------------------------------- /man/wbt_license.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_license} 4 | \alias{wbt_license} 5 | \title{License information for 'WhiteboxTools'} 6 | \usage{ 7 | wbt_license() 8 | } 9 | \value{ 10 | Returns the license information for WhiteboxTools as an R character vector. 11 | } 12 | \description{ 13 | License information for 'WhiteboxTools' 14 | } 15 | \examples{ 16 | \dontrun{ 17 | wbt_license() 18 | } 19 | } 20 | \keyword{General} 21 | -------------------------------------------------------------------------------- /man/wbt_lidar_join.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/lidar_analysis.R 3 | \name{wbt_lidar_join} 4 | \alias{wbt_lidar_join} 5 | \title{Lidar join} 6 | \usage{ 7 | wbt_lidar_join( 8 | inputs, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{inputs}{Input LiDAR files.} 18 | 19 | \item{output}{Output LiDAR file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Joins multiple LiDAR (LAS) files into a single LAS file. 34 | } 35 | \keyword{LiDARTools} 36 | -------------------------------------------------------------------------------- /man/wbt_lidar_sort_by_time.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/lidar_analysis.R 3 | \name{wbt_lidar_sort_by_time} 4 | \alias{wbt_lidar_sort_by_time} 5 | \title{Lidar sort by time} 6 | \usage{ 7 | wbt_lidar_sort_by_time( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Name of the input LiDAR points.} 18 | 19 | \item{output}{Name of the output LiDAR points.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | This tool sorts the points in a LiDAR file by the GPS time. 34 | } 35 | \keyword{LiDARTools} 36 | -------------------------------------------------------------------------------- /man/wbt_line_thinning.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/image_analysis.R 3 | \name{wbt_line_thinning} 4 | \alias{wbt_line_thinning} 5 | \title{Line thinning} 6 | \usage{ 7 | wbt_line_thinning( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Performs line thinning a on Boolean raster image; intended to be used with the RemoveSpurs tool. 34 | } 35 | \keyword{ImageProcessingTools} 36 | -------------------------------------------------------------------------------- /man/wbt_linearity_index.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_linearity_index} 4 | \alias{wbt_linearity_index} 5 | \title{Linearity index} 6 | \usage{ 7 | wbt_linearity_index( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the linearity index for vector polygons. 31 | } 32 | \keyword{GISAnalysisPatchShapeTools} 33 | -------------------------------------------------------------------------------- /man/wbt_lines_to_polygons.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_lines_to_polygons} 4 | \alias{wbt_lines_to_polygons} 5 | \title{Lines to polygons} 6 | \usage{ 7 | wbt_lines_to_polygons( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector line file.} 18 | 19 | \item{output}{Output vector polygon file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Converts vector polylines to polygons. 34 | } 35 | \keyword{DataTools} 36 | -------------------------------------------------------------------------------- /man/wbt_list_tools.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_list_tools} 4 | \alias{wbt_list_tools} 5 | \title{All available tools in 'WhiteboxTools'} 6 | \usage{ 7 | wbt_list_tools(keywords = "''") 8 | } 9 | \arguments{ 10 | \item{keywords}{Keywords may be used to search available tools. Default \code{"''"} returns all available tools.} 11 | } 12 | \value{ 13 | Return all available tools in WhiteboxTools that contain the keywords. 14 | } 15 | \description{ 16 | All available tools in 'WhiteboxTools' 17 | } 18 | \examples{ 19 | \dontrun{ 20 | wbt_list_tools("lidar") 21 | } 22 | } 23 | \keyword{General} 24 | -------------------------------------------------------------------------------- /man/wbt_list_unique_values_raster.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_list_unique_values_raster} 4 | \alias{wbt_list_unique_values_raster} 5 | \title{List unique values raster} 6 | \usage{ 7 | wbt_list_unique_values_raster( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector file path. See \code{wbt_file_path()} for details.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Lists the unique values contained in a field within a vector's attribute table. 31 | } 32 | \keyword{MathandStatsTools} 33 | -------------------------------------------------------------------------------- /man/wbt_ln.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_ln} 4 | \alias{wbt_ln} 5 | \title{Ln} 6 | \usage{ 7 | wbt_ln( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the natural logarithm of values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_log10.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_log10} 4 | \alias{wbt_log10} 5 | \title{Log10} 6 | \usage{ 7 | wbt_log10( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the base-10 logarithm of values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_log2.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_log2} 4 | \alias{wbt_log2} 5 | \title{Log2} 6 | \usage{ 7 | wbt_log2( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the base-2 logarithm of values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_max.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_max} 4 | \alias{wbt_max} 5 | \title{Max} 6 | \usage{ 7 | wbt_max( 8 | input1, 9 | input2, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{input1}{Input raster file or constant value.} 19 | 20 | \item{input2}{Input raster file or constant value.} 21 | 22 | \item{output}{Output raster file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Performs a MAX operation on two rasters or a raster and a constant value. 37 | } 38 | \keyword{MathandStatsTools} 39 | -------------------------------------------------------------------------------- /man/wbt_medoid.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_medoid} 4 | \alias{wbt_medoid} 5 | \title{Medoid} 6 | \usage{ 7 | wbt_medoid( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output vector file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates the medoid for a series of vector features contained in a shapefile. 34 | } 35 | \keyword{GISAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_min.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_min} 4 | \alias{wbt_min} 5 | \title{Min} 6 | \usage{ 7 | wbt_min( 8 | input1, 9 | input2, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{input1}{Input raster file or constant value.} 19 | 20 | \item{input2}{Input raster file or constant value.} 21 | 22 | \item{output}{Output raster file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Performs a MIN operation on two rasters or a raster and a constant value. 37 | } 38 | \keyword{MathandStatsTools} 39 | -------------------------------------------------------------------------------- /man/wbt_modify_no_data_value.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_modify_no_data_value} 4 | \alias{wbt_modify_no_data_value} 5 | \title{Modify no data value} 6 | \usage{ 7 | wbt_modify_no_data_value( 8 | input, 9 | new_value = "-32768.0", 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{new_value}{New NoData value.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Modifies nodata values in a raster. 34 | } 35 | \keyword{DataTools} 36 | -------------------------------------------------------------------------------- /man/wbt_modulo.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_modulo} 4 | \alias{wbt_modulo} 5 | \title{Modulo} 6 | \usage{ 7 | wbt_modulo( 8 | input1, 9 | input2, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{input1}{Input raster file or constant value.} 19 | 20 | \item{input2}{Input raster file or constant value.} 21 | 22 | \item{output}{Output raster file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Performs a modulo operation on two rasters or a raster and a constant value. 37 | } 38 | \keyword{MathandStatsTools} 39 | -------------------------------------------------------------------------------- /man/wbt_narrowness_index.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_narrowness_index} 4 | \alias{wbt_narrowness_index} 5 | \title{Narrowness index} 6 | \usage{ 7 | wbt_narrowness_index( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates the narrowness of raster polygons. 34 | } 35 | \keyword{GISAnalysisPatchShapeTools} 36 | -------------------------------------------------------------------------------- /man/wbt_negate.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_negate} 4 | \alias{wbt_negate} 5 | \title{Negate} 6 | \usage{ 7 | wbt_negate( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Changes the sign of values in a raster or the 0-1 values of a Boolean raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_num_downslope_neighbours.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/terrain_analysis.R 3 | \name{wbt_num_downslope_neighbours} 4 | \alias{wbt_num_downslope_neighbours} 5 | \title{Num downslope neighbours} 6 | \usage{ 7 | wbt_num_downslope_neighbours( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates the number of downslope neighbours to each grid cell in a DEM. 34 | } 35 | \keyword{GeomorphometricAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_num_upslope_neighbours.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/terrain_analysis.R 3 | \name{wbt_num_upslope_neighbours} 4 | \alias{wbt_num_upslope_neighbours} 5 | \title{Num upslope neighbours} 6 | \usage{ 7 | wbt_num_upslope_neighbours( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates the number of upslope neighbours to each grid cell in a DEM. 34 | } 35 | \keyword{GeomorphometricAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_patch_orientation.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_patch_orientation} 4 | \alias{wbt_patch_orientation} 5 | \title{Patch orientation} 6 | \usage{ 7 | wbt_patch_orientation( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the orientation of vector polygons. 31 | } 32 | \keyword{GISAnalysisPatchShapeTools} 33 | -------------------------------------------------------------------------------- /man/wbt_perimeter_area_ratio.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_perimeter_area_ratio} 4 | \alias{wbt_perimeter_area_ratio} 5 | \title{Perimeter area ratio} 6 | \usage{ 7 | wbt_perimeter_area_ratio( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the perimeter-area ratio of vector polygons. 31 | } 32 | \keyword{GISAnalysisPatchShapeTools} 33 | -------------------------------------------------------------------------------- /man/wbt_polygon_area.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_polygon_area} 4 | \alias{wbt_polygon_area} 5 | \title{Polygon area} 6 | \usage{ 7 | wbt_polygon_area( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the area of vector polygons. 31 | } 32 | \keyword{GISAnalysis} 33 | -------------------------------------------------------------------------------- /man/wbt_polygon_long_axis.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_polygon_long_axis} 4 | \alias{wbt_polygon_long_axis} 5 | \title{Polygon long axis} 6 | \usage{ 7 | wbt_polygon_long_axis( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector polygons file.} 18 | 19 | \item{output}{Output vector polyline file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Used to map the long axis of polygon features. 34 | } 35 | \keyword{GISAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_polygon_perimeter.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_polygon_perimeter} 4 | \alias{wbt_polygon_perimeter} 5 | \title{Polygon perimeter} 6 | \usage{ 7 | wbt_polygon_perimeter( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the perimeter of vector polygons. 31 | } 32 | \keyword{GISAnalysis} 33 | -------------------------------------------------------------------------------- /man/wbt_polygon_short_axis.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_polygon_short_axis} 4 | \alias{wbt_polygon_short_axis} 5 | \title{Polygon short axis} 6 | \usage{ 7 | wbt_polygon_short_axis( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector polygons file.} 18 | 19 | \item{output}{Output vector polyline file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Used to map the short axis of polygon features. 34 | } 35 | \keyword{GISAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_polygonize.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_overlay.R 3 | \name{wbt_polygonize} 4 | \alias{wbt_polygonize} 5 | \title{Polygonize} 6 | \usage{ 7 | wbt_polygonize( 8 | inputs, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{inputs}{Input vector polyline file.} 18 | 19 | \item{output}{Output vector polygon file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Creates a polygon layer from two or more intersecting line features contained in one or more input vector line files. 34 | } 35 | \keyword{GISAnalysisOverlayTools} 36 | -------------------------------------------------------------------------------- /man/wbt_polygons_to_lines.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_polygons_to_lines} 4 | \alias{wbt_polygons_to_lines} 5 | \title{Polygons to lines} 6 | \usage{ 7 | wbt_polygons_to_lines( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector polygon file.} 18 | 19 | \item{output}{Output vector lines file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Converts vector polygons to polylines. 34 | } 35 | \keyword{DataTools} 36 | -------------------------------------------------------------------------------- /man/wbt_print_geo_tiff_tags.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_print_geo_tiff_tags} 4 | \alias{wbt_print_geo_tiff_tags} 5 | \title{Print geo tiff tags} 6 | \usage{ 7 | wbt_print_geo_tiff_tags( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input GeoTIFF file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Prints the tags within a GeoTIFF. 31 | } 32 | \keyword{DataTools} 33 | -------------------------------------------------------------------------------- /man/wbt_profile.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/terrain_analysis.R 3 | \name{wbt_profile} 4 | \alias{wbt_profile} 5 | \title{Profile} 6 | \usage{ 7 | wbt_profile( 8 | lines, 9 | surface, 10 | output, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{lines}{Input vector line file.} 19 | 20 | \item{surface}{Input raster surface file.} 21 | 22 | \item{output}{Output HTML file.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Plots profiles from digital surface models. 37 | } 38 | \keyword{GeomorphometricAnalysis} 39 | -------------------------------------------------------------------------------- /man/wbt_quantiles.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_quantiles} 4 | \alias{wbt_quantiles} 5 | \title{Quantiles} 6 | \usage{ 7 | wbt_quantiles( 8 | input, 9 | output, 10 | num_quantiles = 5, 11 | wd = NULL, 12 | verbose_mode = NULL, 13 | compress_rasters = NULL, 14 | command_only = FALSE 15 | ) 16 | } 17 | \arguments{ 18 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 19 | 20 | \item{output}{Output raster file.} 21 | 22 | \item{num_quantiles}{Number of quantiles.} 23 | 24 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 25 | 26 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 27 | 28 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 29 | 30 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 31 | } 32 | \value{ 33 | Returns the tool text outputs. 34 | } 35 | \description{ 36 | Transforms raster values into quantiles. 37 | } 38 | \keyword{MathandStatsTools} 39 | -------------------------------------------------------------------------------- /man/wbt_random_field.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_random_field} 4 | \alias{wbt_random_field} 5 | \title{Random field} 6 | \usage{ 7 | wbt_random_field( 8 | base, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{base}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Creates an image containing random values. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_raster_summary_stats.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_raster_summary_stats} 4 | \alias{wbt_raster_summary_stats} 5 | \title{Raster summary stats} 6 | \usage{ 7 | wbt_raster_summary_stats( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Measures a rasters min, max, average, standard deviation, num. non-nodata cells, and total. 31 | } 32 | \keyword{MathandStatsTools} 33 | -------------------------------------------------------------------------------- /man/wbt_raster_to_vector_lines.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_raster_to_vector_lines} 4 | \alias{wbt_raster_to_vector_lines} 5 | \title{Raster to vector lines} 6 | \usage{ 7 | wbt_raster_to_vector_lines( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster lines file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Converts a raster lines features into a vector of the POLYLINE shapetype. 34 | } 35 | \keyword{DataTools} 36 | -------------------------------------------------------------------------------- /man/wbt_reciprocal.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_reciprocal} 4 | \alias{wbt_reciprocal} 5 | \title{Reciprocal} 6 | \usage{ 7 | wbt_reciprocal( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the reciprocal (i.e. 1 / z) of values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_reinitialize_attribute_table.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_reinitialize_attribute_table} 4 | \alias{wbt_reinitialize_attribute_table} 5 | \title{Reinitialize attribute table} 6 | \usage{ 7 | wbt_reinitialize_attribute_table( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector file path. See \code{wbt_file_path()} for details.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Reinitializes a vector's attribute table deleting all fields but the feature ID (FID). 31 | } 32 | \keyword{DataTools} 33 | -------------------------------------------------------------------------------- /man/wbt_related_circumscribing_circle.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_related_circumscribing_circle} 4 | \alias{wbt_related_circumscribing_circle} 5 | \title{Related circumscribing circle} 6 | \usage{ 7 | wbt_related_circumscribing_circle( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates the related circumscribing circle of vector polygons. 31 | } 32 | \keyword{GISAnalysisPatchShapeTools} 33 | -------------------------------------------------------------------------------- /man/wbt_remove_polygon_holes.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data_tools.R 3 | \name{wbt_remove_polygon_holes} 4 | \alias{wbt_remove_polygon_holes} 5 | \title{Remove polygon holes} 6 | \usage{ 7 | wbt_remove_polygon_holes( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector polygon file.} 18 | 19 | \item{output}{Output vector polygon file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Removes holes within the features of a vector polygon file. 34 | } 35 | \keyword{DataTools} 36 | -------------------------------------------------------------------------------- /man/wbt_round.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_round} 4 | \alias{wbt_round} 5 | \title{Round} 6 | \usage{ 7 | wbt_round( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Rounds the values in an input raster to the nearest integer value. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_ruggedness_index.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/terrain_analysis.R 3 | \name{wbt_ruggedness_index} 4 | \alias{wbt_ruggedness_index} 5 | \title{Ruggedness index} 6 | \usage{ 7 | wbt_ruggedness_index( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates the Riley et al.'s (1999) terrain ruggedness index from an input DEM. 34 | } 35 | \keyword{GeomorphometricAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_run_tool.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_run_tool} 4 | \alias{wbt_run_tool} 5 | \title{Run a tool in 'WhiteboxTools' by name} 6 | \usage{ 7 | wbt_run_tool(tool_name, args, verbose_mode = FALSE, command_only = FALSE) 8 | } 9 | \arguments{ 10 | \item{tool_name}{The name of the tool to run.} 11 | 12 | \item{args}{Tool arguments.} 13 | 14 | \item{verbose_mode}{Verbose mode. Without this flag, tool outputs will not be printed.} 15 | 16 | \item{command_only}{Return command that would be run with \code{system()}? Default: \code{FALSE}} 17 | } 18 | \value{ 19 | Returns the (character) output of the tool. 20 | } 21 | \description{ 22 | Runs a tool and specifies tool arguments. If the prefix "whitebox::" or "wbt_" is in \code{tool_name} it is removed to match the definitions in \code{wbt_list_tools()} 23 | } 24 | \examples{ 25 | \dontrun{ 26 | tool_name <- "breach_depressions" 27 | dem <- system.file("extdata", "DEM.tif", package="whitebox") 28 | output <- "./output.tif" 29 | arg1 <- paste0("--dem=", dem) 30 | arg2 <- paste0("--output=", output) 31 | args <- paste(arg1, arg2) 32 | wbt_run_tool(tool_name, args) 33 | } 34 | } 35 | \seealso{ 36 | \link{wbt_list_tools} 37 | } 38 | \keyword{General} 39 | -------------------------------------------------------------------------------- /man/wbt_rust_backtrace.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_rust_backtrace} 4 | \alias{wbt_rust_backtrace} 5 | \title{Convenience method for setting RUST_BACKTRACE options for debugging} 6 | \usage{ 7 | wbt_rust_backtrace(RUST_BACKTRACE = c("0", "1", "full")) 8 | } 9 | \arguments{ 10 | \item{RUST_BACKTRACE}{One of \code{"0"}, \code{"1"}, \code{"full"}, Logical values are converted to integer and then character.} 11 | } 12 | \value{ 13 | value of system environment variable \code{RUST_BACKTRACE} 14 | } 15 | \description{ 16 | Convenience method for setting RUST_BACKTRACE options for debugging 17 | } 18 | \examples{ 19 | \dontrun{ 20 | wbt_rust_backtrace(TRUE) 21 | } 22 | } 23 | \keyword{General} 24 | -------------------------------------------------------------------------------- /man/wbt_shape_complexity_index.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis_patch_shape.R 3 | \name{wbt_shape_complexity_index} 4 | \alias{wbt_shape_complexity_index} 5 | \title{Shape complexity index} 6 | \usage{ 7 | wbt_shape_complexity_index( 8 | input, 9 | wd = NULL, 10 | verbose_mode = NULL, 11 | compress_rasters = NULL, 12 | command_only = FALSE 13 | ) 14 | } 15 | \arguments{ 16 | \item{input}{Input vector polygon file.} 17 | 18 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 19 | 20 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 21 | 22 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 23 | 24 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 25 | } 26 | \value{ 27 | Returns the tool text outputs. 28 | } 29 | \description{ 30 | Calculates overall polygon shape complexity or irregularity. 31 | } 32 | \keyword{GISAnalysisPatchShapeTools} 33 | -------------------------------------------------------------------------------- /man/wbt_sin.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_sin} 4 | \alias{wbt_sin} 5 | \title{Sin} 6 | \usage{ 7 | wbt_sin( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the sine (sin) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_sinh.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_sinh} 4 | \alias{wbt_sinh} 5 | \title{Sinh} 6 | \usage{ 7 | wbt_sinh( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the hyperbolic sine (sinh) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_source.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt_source.R 3 | \name{wbt_source} 4 | \alias{wbt_source} 5 | \title{Initialize an R object containing spatial data for use by WhiteboxTools} 6 | \usage{ 7 | wbt_source( 8 | x, 9 | dsn = NULL, 10 | layer = NULL, 11 | force = FALSE, 12 | verbose = wbt_verbose(), 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{x}{A terra SpatVector or sf object, or a path to a file that can be read as a SpatVectorProxy} 18 | 19 | \item{dsn}{Data source path / file name} 20 | 21 | \item{layer}{Data layer} 22 | 23 | \item{force}{Force write of vector data to file? Default: FALSE (only write if file does not exist)} 24 | 25 | \item{verbose}{Print information about data source and contents?} 26 | 27 | \item{...}{Additional arguments passed to \code{terra::writeVector()} or \code{sf::st_write()}} 28 | } 29 | \value{ 30 | An R object with attributes \code{wbt_dsn} and \code{wbt_layer} set as needed to support reading and writing R objects from file by WhiteboxTools. 31 | } 32 | \description{ 33 | Initialize an R object containing spatial data for use by WhiteboxTools 34 | } 35 | \keyword{General} 36 | -------------------------------------------------------------------------------- /man/wbt_square.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_square} 4 | \alias{wbt_square} 5 | \title{Square} 6 | \usage{ 7 | wbt_square( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Squares the values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_square_root.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_square_root} 4 | \alias{wbt_square_root} 5 | \title{Square root} 6 | \usage{ 7 | wbt_square_root( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the square root of the values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_surface_area_ratio.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/terrain_analysis.R 3 | \name{wbt_surface_area_ratio} 4 | \alias{wbt_surface_area_ratio} 5 | \title{Surface area ratio} 6 | \usage{ 7 | wbt_surface_area_ratio( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Calculates a the surface area ratio of each grid cell in an input DEM. 34 | } 35 | \keyword{GeomorphometricAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_tan.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_tan} 4 | \alias{wbt_tan} 5 | \title{Tan} 6 | \usage{ 7 | wbt_tan( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the tangent (tan) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_tanh.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_tanh} 4 | \alias{wbt_tanh} 5 | \title{Tanh} 6 | \usage{ 7 | wbt_tanh( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Returns the hyperbolic tangent (tanh) of each values in a raster. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_thicken_raster_line.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/image_analysis.R 3 | \name{wbt_thicken_raster_line} 4 | \alias{wbt_thicken_raster_line} 5 | \title{Thicken raster line} 6 | \usage{ 7 | wbt_thicken_raster_line( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Thickens single-cell wide lines within a raster image. 34 | } 35 | \keyword{ImageProcessingTools} 36 | -------------------------------------------------------------------------------- /man/wbt_to_degrees.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_to_degrees} 4 | \alias{wbt_to_degrees} 5 | \title{To degrees} 6 | \usage{ 7 | wbt_to_degrees( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Converts a raster from radians to degrees. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_to_radians.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_to_radians} 4 | \alias{wbt_to_radians} 5 | \title{To radians} 6 | \usage{ 7 | wbt_to_radians( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Converts a raster from degrees to radians. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbt_tool_help.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_tool_help} 4 | \alias{wbt_tool_help} 5 | \title{Help description for a specific tool in 'WhiteboxTools'} 6 | \usage{ 7 | wbt_tool_help(tool_name = NULL) 8 | } 9 | \arguments{ 10 | \item{tool_name}{The name of the tool.} 11 | } 12 | \value{ 13 | Returns the help description for a specific tool. 14 | } 15 | \description{ 16 | Retrieves the help description for a specific tool. 17 | } 18 | \details{ 19 | Leaving \code{tool_name} as default \code{NULL} returns results for all tools, but does not work on Windows. 20 | } 21 | \examples{ 22 | \dontrun{ 23 | wbt_tool_help("lidar_info") 24 | } 25 | } 26 | \keyword{General} 27 | -------------------------------------------------------------------------------- /man/wbt_tool_parameters.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_tool_parameters} 4 | \alias{wbt_tool_parameters} 5 | \title{Tool parameter descriptions for a specific tool in 'WhiteboxTools'} 6 | \usage{ 7 | wbt_tool_parameters(tool_name, quiet = FALSE) 8 | } 9 | \arguments{ 10 | \item{tool_name}{The name of the tool.} 11 | 12 | \item{quiet}{Prevent tool output being printed. Default: \code{FALSE}} 13 | } 14 | \value{ 15 | Returns the tool parameter descriptions for a specific tool. 16 | } 17 | \description{ 18 | Retrieves the tool parameter descriptions for a specific tool. 19 | } 20 | \details{ 21 | \code{quiet} argument can be set to \code{TRUE} to allow for "quiet" internal use within other functions. 22 | } 23 | \examples{ 24 | \dontrun{ 25 | wbt_tool_parameters("lidar_info") 26 | } 27 | } 28 | \keyword{General} 29 | -------------------------------------------------------------------------------- /man/wbt_toolbox.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_toolbox} 4 | \alias{wbt_toolbox} 5 | \title{The toolbox for a specific tool in WhiteboxTools} 6 | \usage{ 7 | wbt_toolbox(tool_name = NULL) 8 | } 9 | \arguments{ 10 | \item{tool_name}{The name of the tool.} 11 | } 12 | \value{ 13 | Returns the toolbox for a specific tool. 14 | } 15 | \description{ 16 | Retrieve the toolbox for a specific tool. 17 | } 18 | \details{ 19 | Leaving \code{tool_name} as default \code{NULL} returns results for all tools, but does not work on Windows. 20 | } 21 | \examples{ 22 | \dontrun{ 23 | wbt_toolbox("breach_depressions") 24 | } 25 | } 26 | \keyword{General} 27 | -------------------------------------------------------------------------------- /man/wbt_upslope_depression_storage.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hydro_analysis.R 3 | \name{wbt_upslope_depression_storage} 4 | \alias{wbt_upslope_depression_storage} 5 | \title{Upslope depression storage} 6 | \usage{ 7 | wbt_upslope_depression_storage( 8 | dem, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{dem}{Input raster DEM file.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Estimates the average upslope depression storage depth. 34 | } 35 | \keyword{HydrologicalAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_version.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_version} 4 | \alias{wbt_version} 5 | \title{Version information for 'WhiteboxTools'} 6 | \usage{ 7 | wbt_version(extract = FALSE) 8 | } 9 | \arguments{ 10 | \item{extract}{Extract semantic version number from first line of result? Default: \code{FALSE}} 11 | } 12 | \value{ 13 | Returns the version information for 'WhiteboxTools' as an R character vector. 14 | } 15 | \description{ 16 | Version information for 'WhiteboxTools' 17 | } 18 | \examples{ 19 | \dontrun{ 20 | wbt_version() 21 | } 22 | } 23 | \keyword{General} 24 | -------------------------------------------------------------------------------- /man/wbt_view_code.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/wbt.R 3 | \name{wbt_view_code} 4 | \alias{wbt_view_code} 5 | \title{Source code for a specific tool in 'WhiteboxTools'} 6 | \usage{ 7 | wbt_view_code(tool_name, viewer = FALSE) 8 | } 9 | \arguments{ 10 | \item{tool_name}{Name of the tool.} 11 | 12 | \item{viewer}{Show source code in browser? default: \code{TRUE}} 13 | } 14 | \value{ 15 | Returns a GitHub URL to view the source code of the tool. 16 | } 17 | \description{ 18 | Opens a web browser to view the source code for a specific tool on the projects source code repository. 19 | } 20 | \examples{ 21 | \dontrun{ 22 | wbt_view_code("breach_depressions") 23 | } 24 | } 25 | \keyword{General} 26 | -------------------------------------------------------------------------------- /man/wbt_voronoi_diagram.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gis_analysis.R 3 | \name{wbt_voronoi_diagram} 4 | \alias{wbt_voronoi_diagram} 5 | \title{Voronoi diagram} 6 | \usage{ 7 | wbt_voronoi_diagram( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input vector points file.} 18 | 19 | \item{output}{Output vector polygon file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Creates a vector Voronoi diagram for a set of vector points. 34 | } 35 | \keyword{GISAnalysis} 36 | -------------------------------------------------------------------------------- /man/wbt_z_scores.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/math_stat_analysis.R 3 | \name{wbt_z_scores} 4 | \alias{wbt_z_scores} 5 | \title{Z scores} 6 | \usage{ 7 | wbt_z_scores( 8 | input, 9 | output, 10 | wd = NULL, 11 | verbose_mode = NULL, 12 | compress_rasters = NULL, 13 | command_only = FALSE 14 | ) 15 | } 16 | \arguments{ 17 | \item{input}{Input raster file path. See \code{wbt_file_path()} for details.} 18 | 19 | \item{output}{Output raster file.} 20 | 21 | \item{wd}{Changes the working directory. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_wd()} for details.} 22 | 23 | \item{verbose_mode}{Sets verbose mode. If verbose mode is \code{FALSE}, tools will not print output messages. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_verbose()} for details.} 24 | 25 | \item{compress_rasters}{Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: \code{NULL} will use the value in WhiteboxTools settings, see \code{wbt_compress_rasters()} for details.} 26 | 27 | \item{command_only}{Return command that would be executed by \code{system()} rather than running tool. Default: \code{FALSE}.} 28 | } 29 | \value{ 30 | Returns the tool text outputs. 31 | } 32 | \description{ 33 | Standardizes the values in an input raster by converting to z-scores. 34 | } 35 | \keyword{MathandStatsTools} 36 | -------------------------------------------------------------------------------- /man/wbttools.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/whitebox-package.R 3 | \docType{data} 4 | \name{wbttools} 5 | \alias{wbttools} 6 | \title{'WhiteboxTools' Tool List} 7 | \format{ 8 | An object of class \code{data.frame} with 537 rows and 8 columns. 9 | } 10 | \source{ 11 | \href{https://github.com/jblindsay/whitebox-tools/releases/}{WhiteboxTools} 12 | } 13 | \usage{ 14 | wbttools 15 | } 16 | \description{ 17 | This data set is a \code{data.frame} containing tools by name and associated R function name 18 | } 19 | \section{Variables}{ 20 | 21 | \itemize{ 22 | \item \code{"tool_name"} - 'WhiteboxTools' tool name 23 | \item \code{"function_name"} - R function name 24 | \item \code{"toolbox_name"} - 'WhiteboxTools' toolbox name 25 | \item \code{"label"} - 'WhiteboxTools' tool label 26 | \item \code{"description"} - Brief description 27 | \item \code{"github"} - Link to related code on 'GitHub' 28 | \item \code{"book"} - Link to 'WhiteboxTools' Manual 29 | \item \code{"is_extension"} - Tool is part of 'General Toolset Extension' (GTE), as opposed to the "open core" 30 | } 31 | } 32 | 33 | \seealso{ 34 | \link{wbttoolparameters} \code{\link[=wbt_list_tools]{wbt_list_tools()}} 35 | } 36 | \keyword{General} 37 | \keyword{datasets} 38 | -------------------------------------------------------------------------------- /misc/custom_exe_path.R: -------------------------------------------------------------------------------- 1 | # demo of custom EXE path 2 | 3 | # on loading library get message about binary not found 4 | library(whitebox) 5 | 6 | # doesn't work with default path e.g.: 7 | # /home/andrew/R/x86_64-pc-linux-gnu-library/4.1/whitebox/WBT/whitebox_tools 8 | ret <- wbt_zonal_statistics(input = "/home/andrew/temp/dem.tif", 9 | features = "/home/andrew/temp/depression_level.tif", 10 | out_table = "output.html") 11 | 12 | # set path to whitebox_tools custom-built with cargo 13 | Sys.setenv(R_WHITEBOX_EXE_PATH = "/home/andrew/workspace/whitebox-tools/target/release/whitebox_tools") 14 | 15 | # works 16 | ret <- wbt_zonal_statistics(input = "/home/andrew/temp/dem.tif", 17 | features = "/home/andrew/temp/depression_level.tif", 18 | out_table = "output.html") 19 | -------------------------------------------------------------------------------- /misc/run_tool_ex.R: -------------------------------------------------------------------------------- 1 | 2 | library(terra) 3 | library(whitebox) 4 | 5 | wbt_wd(tempdir()) 6 | 7 | # sample DEM with whitebox package 8 | p <- sample_dem_data() 9 | wbt(wbt_aggregate_raster, input = p, output = "agg.tif") 10 | 11 | # SpatRaster input, output path as character 12 | x <- wbt(wbt_slope, dem = rast(p), output = "slope.tif", units = 'percent') 13 | 14 | # test for bad result 15 | inherits(x$result, 'try-error') 16 | 17 | # SpatRaster input, output path as character 18 | x <- wbt(wbt_slope, dem = rast(p), output = "slope.tif") 19 | 20 | # wbtresult$output contains a RasterLayer with output raster "slope.tif" 21 | plot(x$result$output) 22 | 23 | # y$result$output contains a RasterLayer with output raster "sca.tif" 24 | y <- wbt( 25 | wbt_d8_flow_accumulation, 26 | input = rast(p), 27 | output = "sca.tif", 28 | out_type = 'specific contributing area' 29 | ) 30 | plot(y$result$output) 31 | 32 | # y$result$output contains a RasterLayer with output raster "wi.tif" 33 | z <- wbt( 34 | wbt_wetness_index, 35 | sca = y$result$output, 36 | slope = x$result$output, 37 | output = "wi.tif" 38 | ) 39 | 40 | plot(z$result$output) 41 | -------------------------------------------------------------------------------- /misc/sample_dem-crs.R: -------------------------------------------------------------------------------- 1 | library(whitebox) 2 | library(terra) 3 | r <- rast(sample_dem_data()) 4 | crs(r) <- "EPSG:26918" 5 | r2 <- rast(r) 6 | res(r2) <- 90 7 | ext(r2) <- c(664692, 664692 + 237 * 90, 8 | 4878904, 4878904 + 188 * 90) 9 | r3 <- project(r, r2) 10 | writeRaster(r3, "inst/extdata/DEM.tif", NAflag = -32768.0, overwrite=TRUE) 11 | -------------------------------------------------------------------------------- /misc/twoargs.R: -------------------------------------------------------------------------------- 1 | library(terra) 2 | library(whitebox) 3 | 4 | wbt_verbose(TRUE) 5 | wbt_wd("") 6 | 7 | # get file path of sample DEM 8 | dem <- sample_dem_data() 9 | rdem <- round(rast(dem)) 10 | 11 | # step 1: calculate slope (input2) 12 | step1 <- wbt("slope", dem = rdem, output = "slope.tif") 13 | wbt_result(step1) 14 | 15 | # step2 uses step1 as first arg and another input as input2 16 | step2 <- wbt(step1, "add", input2 = rdem, output = "foo.tif") 17 | x <- step2 |> 18 | wbt_result() |> 19 | rast() 20 | plot(x) 21 | 22 | # check the math 23 | plot(round(x[["foo"]] - x[["slope"]]) - rdem) 24 | 25 | # no rounding 26 | plot((x[["foo"]] - x[["slope"]]) - rdem) 27 | 28 | unlink(c(dem2, "foo.tif")) 29 | -------------------------------------------------------------------------------- /misc/wbt_source.R: -------------------------------------------------------------------------------- 1 | library(soilDB) 2 | library(terra) 3 | library(whitebox) 4 | 5 | wbt_wd("") 6 | 7 | b <- c(-119.747629, -119.67935, 8 | 36.912019, 36.944987) 9 | 10 | # convert bounding box to WKT 11 | bbox.sp <- sf::st_as_sf(wk::rct( 12 | xmin = b[1], xmax = b[2], ymin = b[3], ymax = b[4], 13 | crs = sf::st_crs(4326) 14 | )) 15 | 16 | ssurgo <- SDA_spatialQuery( 17 | bbox.sp, 18 | what = 'mupolygon', 19 | db = 'SSURGO', 20 | geomIntersection = TRUE 21 | ) 22 | 23 | wbt("vector_polygons_to_raster", 24 | input = terra::vect(ssurgo), 25 | output = 'ssurgo3.tif', 26 | field = "mukey", 27 | cell_size = 0.0001) 28 | plot(rast('ssurgo3.tif')) # TODO update TIFF CRS w/ terra ~1.6-27 29 | 30 | wbt("slope", dem = rast(matrix(1:100, nrow=10, ncol=10), crs='EPSG:4326'), output = "output.tif") 31 | 32 | t1 <- rast(matrix(rep(c(0,1),50), nrow=10, ncol=10), crs="EPSG:4326") 33 | t2 <- rast(matrix(rep(c(1,0),50), nrow=10, ncol=10), crs="EPSG:4326") 34 | 35 | plot(t1) 36 | plot(t2) 37 | 38 | t3 <- wbt_add2(t1, t2, "output.tif") |> 39 | wbt_result() |> 40 | rast() 41 | plot(c(t1, t2, t3)) 42 | 43 | -------------------------------------------------------------------------------- /tests/testthat.R: -------------------------------------------------------------------------------- 1 | library(testthat) 2 | library(whitebox) 3 | # whitebox:::wbt_rust_backtrace('1') 4 | test_check("whitebox") 5 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_absolute_value.R: -------------------------------------------------------------------------------- 1 | context("wbt_absolute_value") 2 | 3 | test_that("Calculates the absolute value of every cell in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_absolute_value(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_arc_cos.R: -------------------------------------------------------------------------------- 1 | context("wbt_arc_cos") 2 | 3 | test_that("Returns the inverse cosine (arccos) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arc_cos(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_arc_sin.R: -------------------------------------------------------------------------------- 1 | context("wbt_arc_sin") 2 | 3 | test_that("Returns the inverse sine (arcsin) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arc_sin(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_arc_tan.R: -------------------------------------------------------------------------------- 1 | context("wbt_arc_tan") 2 | 3 | test_that("Returns the inverse tangent (arctan) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arc_tan(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_arcosh.R: -------------------------------------------------------------------------------- 1 | context("wbt_arcosh") 2 | 3 | test_that("Returns the inverse hyperbolic cosine (arcosh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arcosh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_arsinh.R: -------------------------------------------------------------------------------- 1 | context("wbt_arsinh") 2 | 3 | test_that("Returns the inverse hyperbolic sine (arsinh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_arsinh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_artanh.R: -------------------------------------------------------------------------------- 1 | context("wbt_artanh") 2 | 3 | test_that("Returns the inverse hyperbolic tangent (arctanh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_artanh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_ceil.R: -------------------------------------------------------------------------------- 1 | context("wbt_ceil") 2 | 3 | test_that("Returns the smallest (closest to negative infinity) value that is greater than or equal to the values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_ceil(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_cos.R: -------------------------------------------------------------------------------- 1 | context("wbt_cos") 2 | 3 | test_that("Returns the cosine (cos) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_cos(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_cosh.R: -------------------------------------------------------------------------------- 1 | context("wbt_cosh") 2 | 3 | test_that("Returns the hyperbolic cosine (cosh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_cosh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_cumulative_distribution.R: -------------------------------------------------------------------------------- 1 | context("wbt_cumulative_distribution") 2 | 3 | test_that("Converts a raster image to its cumulative distribution function", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_cumulative_distribution(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_decrement.R: -------------------------------------------------------------------------------- 1 | context("wbt_decrement") 2 | 3 | test_that("Decreases the values of each grid cell in an input raster by 10 (see also InPlaceSubtract)", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_decrement(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_exp.R: -------------------------------------------------------------------------------- 1 | context("wbt_exp") 2 | 3 | test_that("Returns the exponential (base e) of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_exp(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_exp2.R: -------------------------------------------------------------------------------- 1 | context("wbt_exp2") 2 | 3 | test_that("Returns the exponential (base 2) of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_exp2(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_floor.R: -------------------------------------------------------------------------------- 1 | context("wbt_floor") 2 | 3 | test_that("Returns the largest (closest to positive infinity) value that is less than or equal to the values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_floor(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_increment.R: -------------------------------------------------------------------------------- 1 | context("wbt_increment") 2 | 3 | test_that("Increases the values of each grid cell in an input raster by 10 (see also InPlaceAdd)", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_increment(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_is_no_data.R: -------------------------------------------------------------------------------- 1 | context("wbt_is_no_data") 2 | 3 | test_that("Identifies NoData valued pixels in an image", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_is_no_data(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_ln.R: -------------------------------------------------------------------------------- 1 | context("wbt_ln") 2 | 3 | test_that("Returns the natural logarithm of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_ln(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_log10.R: -------------------------------------------------------------------------------- 1 | context("wbt_log10") 2 | 3 | test_that("Returns the base-10 logarithm of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_log10(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_log2.R: -------------------------------------------------------------------------------- 1 | context("wbt_log2") 2 | 3 | test_that("Returns the base-2 logarithm of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_log2(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_negate.R: -------------------------------------------------------------------------------- 1 | context("wbt_negate") 2 | 3 | test_that("Changes the sign of values in a raster or the 0-1 values of a Boolean raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_negate(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_quantiles.R: -------------------------------------------------------------------------------- 1 | context("wbt_quantiles") 2 | 3 | test_that("Transforms raster values into quantiles", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_quantiles(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_reciprocal.R: -------------------------------------------------------------------------------- 1 | context("wbt_reciprocal") 2 | 3 | test_that("Returns the reciprocal (ie 1 / z) of values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_reciprocal(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_round.R: -------------------------------------------------------------------------------- 1 | context("wbt_round") 2 | 3 | test_that("Rounds the values in an input raster to the nearest integer value", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_round(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_sin.R: -------------------------------------------------------------------------------- 1 | context("wbt_sin") 2 | 3 | test_that("Returns the sine (sin) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_sin(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_sinh.R: -------------------------------------------------------------------------------- 1 | context("wbt_sinh") 2 | 3 | test_that("Returns the hyperbolic sine (sinh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_sinh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_square.R: -------------------------------------------------------------------------------- 1 | context("wbt_square") 2 | 3 | test_that("Squares the values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_square(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_square_root.R: -------------------------------------------------------------------------------- 1 | context("wbt_square_root") 2 | 3 | test_that("Returns the square root of the values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_square_root(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_tan.R: -------------------------------------------------------------------------------- 1 | context("wbt_tan") 2 | 3 | test_that("Returns the tangent (tan) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_tan(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_tanh.R: -------------------------------------------------------------------------------- 1 | context("wbt_tanh") 2 | 3 | test_that("Returns the hyperbolic tangent (tanh) of each values in a raster", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_tanh(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_to_degrees.R: -------------------------------------------------------------------------------- 1 | context("wbt_to_degrees") 2 | 3 | test_that("Converts a raster from radians to degrees", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_to_degrees(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_to_radians.R: -------------------------------------------------------------------------------- 1 | context("wbt_to_radians") 2 | 3 | test_that("Converts a raster from degrees to radians", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_to_radians(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_truncate.R: -------------------------------------------------------------------------------- 1 | context("wbt_truncate") 2 | 3 | test_that("Truncates the values in a raster to the desired number of decimal places", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_truncate(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-wbt_z_scores.R: -------------------------------------------------------------------------------- 1 | context("wbt_z_scores") 2 | 3 | test_that("Standardizes the values in an input raster by converting to z-scores", { 4 | 5 | skip_on_cran() 6 | skip_if_not(check_whitebox_binary()) 7 | dem <- sample_dem_data(); skip_if(dem == "") 8 | ret <- wbt_z_scores(input = dem, output = "output.tif") 9 | expect_match(ret, "Elapsed Time") 10 | 11 | }) 12 | -------------------------------------------------------------------------------- /tests/testthat/test-whitebox-package.R: -------------------------------------------------------------------------------- 1 | test_that("whitebox datasets", { 2 | 3 | # at least one row and the R `function_name` is defined in both datasets 4 | expect_true(nrow(wbttools) > 0 & "function_name" %in% colnames(wbttools)) 5 | expect_true(nrow(wbttoolparameters) > 0 & "function_name" %in% colnames(wbttoolparameters)) 6 | 7 | # no list columns 8 | expect_true(!any(sapply(wbttoolparameters, is.list))) 9 | 10 | # parameters available for every tool 11 | expect_true(all(wbttoolparameters$function_name %in% wbttools$function_name)) 12 | expect_true(all(wbttools$function_name %in% wbttoolparameters$function_name)) 13 | }) 14 | 15 | test_that("cleanup", { 16 | 17 | skip_on_cran() 18 | 19 | skip_if_not(check_whitebox_binary()) 20 | 21 | expect_true(is.numeric(unlink(c('output.tif', 'settings.json')))) 22 | 23 | }) 24 | -------------------------------------------------------------------------------- /vignettes/.gitignore: -------------------------------------------------------------------------------- 1 | *.html 2 | *.R 3 | --------------------------------------------------------------------------------