Skip to content
Snippets Groups Projects
Commit b10e0c5f authored by fvafrcu's avatar fvafrcu
Browse files

Export function `check_boundaries()`

parent fdf42926
No related branches found
No related tags found
No related merge requests found
Pipeline #600469846 passed
......@@ -2,6 +2,7 @@
export(bw2bwi2022de)
export(bwi2cartesian)
export(check_boundaries)
export(get_boundary_polygons)
export(get_boundary_radius)
export(get_correction_factors)
......
# treePlotArea 1.2.0
* Exported function `check_boundaries()`. It looks for invalid boundaries, one
of which occurs in the federal database of the 2012 survey.
* `select_valid_angle_count_trees()` now removes trees with a diameter at breast
height greater than zero and a distance of 0, for these tree should not be
there.
......
#' Check Validity of Boundaries
#'
#' There is a boundary (tract 6878, corner 1, boundary 1)in the federal database
#' for the 2012 survey that runs exactly through the plot. If that boundary
#' would be valid, at that corner the term "stand" is not defined.
#'
#' So we check for such boundaries. These are straight boundaries with identical
#' azimuth values for start and end, and flexed boundaries where azimuth values
#' for either start or end and the azimuth value for the nook are identical and
#' the nook is farther away form the plot than the corresponding start or end.
#' @param x A \code{\link{data.frame}} containing boundaries.
#' It has to have columns named by the contents of
#' either\cr
#' \code{\link{get_defaults}("boundaries")} or \cr
#' \code{fritools::get_options(package_name = "treePlotArea")[["boundaries"]]}.
#' \cr
#' Could be
#' \code{get(data("boundaries", package = "treePlotArea"))}.
#' @param stop_on_error Throw an error if invalid boundaries are found?
#' @param clean_data Get rid of invalid boundaries?
#' @return A (possibly cleansed) \code{\link{data.frame}} containing boundaries.
#' @export
#' @family boundary functions
check_boundaries <- function(x, stop_on_error = TRUE, clean_data = FALSE) {
# boundaries with identical azimth values for an two measurements cut
# through the origin. Get rid of them.
options <- get_options("boundaries")
res <- x
index_invalid <- apply(res, 1, goes_through_origin)
......
......@@ -12,12 +12,13 @@
#' Could be
#' \code{get(data("boundaries", package = "treePlotArea"))}.
#' @param stop_on_error Throw an error if invalid boundaries are encountered?
#' (There was tract 6878, corner 1, boundary 1 in the federal
#' (There was tract 6878, corner 1, boundary 1 in the federal
#' database for the 2012 survey, runs through the plot.
#' There is no stand defined that way!).
#' @param clean_data Omit invalid boundaries in any further calculations?
#' @return A list with all boundary polygons for each corner for each tract.
#' @export
#' @family boundary functions
#' @examples
#' boundaries <- get(data("boundaries", package = "treePlotArea"))
#' boundary_polygons <- get_boundary_polygons(boundaries)
......
Dear CRAN Team,
this is a resubmission of package 'treePlotArea'. I have added the following changes:
* Exported function `check_boundaries()`. It looks for invalid boundaries, one
of which occurs in the federal database of the 2012 survey.
* `select_valid_angle_count_trees()` now removes trees with a diameter at breast
height greater than zero and a distance of 0, for these tree should not be
there.
......@@ -18,10 +20,10 @@ Reporting is done by packager version 1.15.0
## Test environments
- R Under development (unstable) (2022-06-23 r82516)
- R Under development (unstable) (2022-07-29 r82645)
Platform: x86_64-pc-linux-gnu (64-bit)
Running under: Devuan GNU/Linux 4 (chimaera)
0 errors | 0 warnings | 1 note
0 errors | 0 warnings | 0 notes
- gitlab.com
R version 4.2.1 (2022-06-23)
Platform: x86_64-pc-linux-gnu (64-bit)
......@@ -29,8 +31,17 @@ Reporting is done by packager version 1.15.0
Package: treePlotArea
Version: 1.2.0
Status: 2 WARNINGs, 1 NOTE
- win-builder (devel)
- win-builder (devel)
Date: Fri, 29 Jul 2022 11:11:05 +0200
Your package treePlotArea_1.2.0.tar.gz has been built (if working) and checked for Windows.
Please check the log files and (if working) the binary package at:
https://win-builder.r-project.org/2FzA8SXFq3I4
The files will be removed after roughly 72 hours.
Installation time in seconds: 8
Check time in seconds: 166
Status: OK
R Under development (unstable) (2022-07-27 r82637 ucrt)
## Local test results
- RUnit:
......@@ -38,7 +49,7 @@ Reporting is done by packager version 1.15.0
- testthat:
[ FAIL 0 | WARN 0 | SKIP 0 | PASS 1 ]
- tinytest:
All ok, 3 results (1.6s)
All ok, 3 results (1.4s)
- Coverage by covr:
treePlotArea Coverage: 85.20%
......@@ -47,7 +58,7 @@ Reporting is done by packager version 1.15.0
Exceeding maximum cyclomatic complexity of 10 for get_correction_factors by 5.
Exceeding maximum cyclomatic complexity of 10 for goes_through_origin by 1.
- lintr:
found 0 lints in 19425 lines of code (a ratio of 0).
found 0 lints in 19447 lines of code (a ratio of 0).
- cleanr:
found 1 dreadful things about your code.
- codetools::checkUsagePackage:
......
......@@ -3,6 +3,8 @@
\section{Changes in version 1.2.0}{
\itemize{
\item Exported function \code{check_boundaries()}. It looks for invalid boundaries, one
of which occurs in the federal database of the 2012 survey.
\item \code{select_valid_angle_count_trees()} now removes trees with a diameter at breast
height greater than zero and a distance of 0, for these tree should not be
there.
......
* using log directory ‘/home/qwer/git/cyclops/fvafrcu/treePlotArea/treePlotArea.Rcheck’
* using R Under development (unstable) (2022-06-23 r82516)
* using R Under development (unstable) (2022-07-29 r82645)
* using platform: x86_64-pc-linux-gnu (64-bit)
* using session charset: UTF-8
* using options ‘--run-donttest --as-cran’
* checking for file ‘treePlotArea/DESCRIPTION’ ... OK
* this is package ‘treePlotArea’ version ‘1.2.0’
* package encoding: UTF-8
* checking CRAN incoming feasibility ... NOTE
* checking CRAN incoming feasibility ... Note_to_CRAN_maintainers
Maintainer: ‘Andreas Dominik Cullmann <fvafrcu@mailbox.org>’
Days since last update: 6
* checking package namespace information ... OK
* checking package dependencies ... OK
* checking if this is a source package ... OK
......@@ -68,8 +66,7 @@ Days since last update: 6
* checking package vignettes in ‘inst/doc’ ... OK
* checking re-building of vignette outputs ... OK
* checking PDF version of manual ... OK
* skipping checking HTML version of manual: no command ‘tidy’ found
* checking for non-standard things in the check directory ... OK
* checking for detritus in the temp directory ... OK
* DONE
Status: 1 NOTE
Status: OK
filename functions line value
178 R/check_boundaries.R check_boundaries 16 0
185 R/check_boundaries.R check_boundaries 17 0
194 R/check_boundaries.R check_boundaries 18 0
213 R/check_boundaries.R check_boundaries 20 0
222 R/check_boundaries.R check_boundaries 21 0
236 R/check_boundaries.R check_boundaries 23 0
322 R/check_boundaries.R check_boundaries 37 0
330 R/check_boundaries.R check_boundaries 38 0
336 R/check_boundaries.R check_boundaries 39 0
348 R/check_boundaries.R check_boundaries 41 0
355 R/check_boundaries.R check_boundaries 42 0
369 R/check_boundaries.R check_boundaries 44 0
7 R/create_tetragon.R create_tetragon 2 0
8 R/create_triangle.R create_triangle 2 0
144 R/delete_extraneous_boundaries.R delete_extraneous_boundaries 11 0
167 R/delete_extraneous_boundaries.R delete_extraneous_boundaries 14 0
136 R/delete_extraneous_boundaries.R delete_extraneous_boundaries 11 0
156 R/delete_extraneous_boundaries.R delete_extraneous_boundaries 14 0
31 R/geodatic2math.R geodatic2math 3 0
273 R/get_correction_factors.R check_tree 28 0
305 R/get_correction_factors.R check_tree 32 0
410 R/get_correction_factors.R get_correction_factor 50 0
439 R/get_correction_factors.R get_correction_factor 59 0
441 R/get_correction_factors.R get_correction_factor 60 0
461 R/get_correction_factors.R get_correction_factor 69 0
464 R/get_correction_factors.R get_correction_factor 70 0
197 R/get_intersection.R get_intersection 18 0
206 R/get_intersection.R get_intersection 19 0
215 R/get_intersection.R get_intersection 20 0
225 R/get_intersection.R get_intersection 21 0
231 R/get_intersection.R get_intersection 22 0
239 R/get_intersection.R get_intersection 23 0
258 R/get_correction_factors.R check_tree 28 0
292 R/get_correction_factors.R check_tree 32 0
395 R/get_correction_factors.R get_correction_factor 50 0
428 R/get_correction_factors.R get_correction_factor 59 0
430 R/get_correction_factors.R get_correction_factor 60 0
458 R/get_correction_factors.R get_correction_factor 69 0
462 R/get_correction_factors.R get_correction_factor 70 0
183 R/get_intersection.R get_intersection 18 0
192 R/get_intersection.R get_intersection 19 0
200 R/get_intersection.R get_intersection 20 0
209 R/get_intersection.R get_intersection 21 0
215 R/get_intersection.R get_intersection 22 0
222 R/get_intersection.R get_intersection 23 0
34 R/get_polygon.R get_polygon 3 0
52 R/get_polygon.R get_polygon 4 0
232 R/orthogonal.R orthogonal 22 0
51 R/get_polygon.R get_polygon 4 0
216 R/orthogonal.R orthogonal 22 0
477 R/plot_tree_plot_area.R plot_tree_plot_area 78 0
478 R/plot_tree_plot_area.R plot_tree_plot_area 79 0
480 R/plot_tree_plot_area.R plot_tree_plot_area 80 0
233 R/points2equation.R points2equation 22 0
240 R/points2equation.R points2equation 23 0
384 R/secant_intersections.R secant_intersections 44 0
393 R/secant_intersections.R secant_intersections 46 0
97 R/tree_and_boundary.R tree_and_boundary 7 0
111 R/tree_and_boundary.R tree_and_boundary 8 0
125 R/tree_and_boundary.R tree_and_boundary 9 0
136 R/tree_and_boundary.R tree_and_boundary 10 0
147 R/tree_and_boundary.R tree_and_boundary 11 0
154 R/tree_and_boundary.R tree_and_boundary 12 0
162 R/tree_and_boundary.R tree_and_boundary 13 0
170 R/tree_and_boundary.R tree_and_boundary 14 0
176 R/tree_and_boundary.R tree_and_boundary 15 0
182 R/tree_and_boundary.R tree_and_boundary 16 0
202 R/tree_and_boundary.R tree_and_boundary 18 0
210 R/tree_and_boundary.R tree_and_boundary 19 0
219 R/tree_and_boundary.R tree_and_boundary 20 0
234 R/tree_and_boundary.R tree_and_boundary 22 0
241 R/tree_and_boundary.R tree_and_boundary 23 0
248 R/tree_and_boundary.R tree_and_boundary 24 0
289 R/validate_data.R validate_data 29 0
297 R/validate_data.R validate_data 30 0
304 R/validate_data.R validate_data 31 0
312 R/validate_data.R validate_data 32 0
317 R/validate_data.R validate_data 33 0
326 R/validate_data.R validate_data 35 0
333 R/validate_data.R validate_data 36 0
339 R/validate_data.R validate_data 37 0
345 R/validate_data.R validate_data 38 0
358 R/validate_data.R validate_data 40 0
364 R/validate_data.R validate_data 41 0
372 R/validate_data.R validate_data 42 0
380 R/validate_data.R validate_data 43 0
389 R/validate_data.R validate_data 45 0
394 R/validate_data.R validate_data 46 0
399 R/validate_data.R validate_data 47 0
404 R/validate_data.R validate_data 48 0
409 R/validate_data.R validate_data 49 0
413 R/validate_data.R validate_data 50 0
416 R/validate_data.R validate_data 51 0
420 R/validate_data.R validate_data 52 0
424 R/validate_data.R validate_data 53 0
427 R/validate_data.R validate_data 54 0
430 R/validate_data.R validate_data 55 0
433 R/validate_data.R validate_data 56 0
438 R/validate_data.R validate_data 58 0
444 R/validate_data.R validate_data 61 0
450 R/validate_data.R validate_data 64 0
452 R/validate_data.R validate_data 65 0
455 R/validate_data.R validate_data 66 0
458 R/validate_data.R validate_data 67 0
463 R/validate_data.R validate_data 69 0
465 R/validate_data.R validate_data 70 0
217 R/points2equation.R points2equation 22 0
223 R/points2equation.R points2equation 23 0
373 R/secant_intersections.R secant_intersections 44 0
380 R/secant_intersections.R secant_intersections 46 0
93 R/tree_and_boundary.R tree_and_boundary 7 0
106 R/tree_and_boundary.R tree_and_boundary 8 0
119 R/tree_and_boundary.R tree_and_boundary 9 0
129 R/tree_and_boundary.R tree_and_boundary 10 0
139 R/tree_and_boundary.R tree_and_boundary 11 0
145 R/tree_and_boundary.R tree_and_boundary 12 0
152 R/tree_and_boundary.R tree_and_boundary 13 0
159 R/tree_and_boundary.R tree_and_boundary 14 0
165 R/tree_and_boundary.R tree_and_boundary 15 0
170 R/tree_and_boundary.R tree_and_boundary 16 0
188 R/tree_and_boundary.R tree_and_boundary 18 0
196 R/tree_and_boundary.R tree_and_boundary 19 0
204 R/tree_and_boundary.R tree_and_boundary 20 0
218 R/tree_and_boundary.R tree_and_boundary 22 0
224 R/tree_and_boundary.R tree_and_boundary 23 0
231 R/tree_and_boundary.R tree_and_boundary 24 0
275 R/validate_data.R validate_data 29 0
283 R/validate_data.R validate_data 30 0
290 R/validate_data.R validate_data 31 0
298 R/validate_data.R validate_data 32 0
304 R/validate_data.R validate_data 33 0
314 R/validate_data.R validate_data 35 0
320 R/validate_data.R validate_data 36 0
327 R/validate_data.R validate_data 37 0
334 R/validate_data.R validate_data 38 0
347 R/validate_data.R validate_data 40 0
353 R/validate_data.R validate_data 41 0
361 R/validate_data.R validate_data 42 0
368 R/validate_data.R validate_data 43 0
377 R/validate_data.R validate_data 45 0
381 R/validate_data.R validate_data 46 0
386 R/validate_data.R validate_data 47 0
390 R/validate_data.R validate_data 48 0
394 R/validate_data.R validate_data 49 0
398 R/validate_data.R validate_data 50 0
401 R/validate_data.R validate_data 51 0
406 R/validate_data.R validate_data 52 0
411 R/validate_data.R validate_data 53 0
414 R/validate_data.R validate_data 54 0
417 R/validate_data.R validate_data 55 0
421 R/validate_data.R validate_data 56 0
427 R/validate_data.R validate_data 58 0
434 R/validate_data.R validate_data 61 0
443 R/validate_data.R validate_data 64 0
446 R/validate_data.R validate_data 65 0
450 R/validate_data.R validate_data 66 0
454 R/validate_data.R validate_data 67 0
461 R/validate_data.R validate_data 69 0
464 R/validate_data.R validate_data 70 0
treePlotArea Coverage: 85.20%
R/get_intersection.R: 0.00%
R/tree_and_boundary.R: 0.00%
......
checking CRAN incoming feasibility ... NOTE
Maintainer: ‘Andreas Dominik Cullmann <fvafrcu@mailbox.org>’
Days since last update: 6
$errors
character(0)
......@@ -9,7 +6,7 @@ $warnings
character(0)
$notes
[1] "checking CRAN incoming feasibility ... NOTE\nMaintainer: ‘Andreas Dominik Cullmann <fvafrcu@mailbox.org>’\n\nDays since last update: 6"
character(0)
attr(,"path")
[1] "./log/check.log"
......
Skipping 1 packages ahead of CRAN: fritools
* checking for file ‘/tmp/RtmpgK6Js8/remotes36f653d5308/treePlotArea/DESCRIPTION’ ... OK
* checking for file ‘/tmp/RtmpZqLFBM/remotes52e42946a082/treePlotArea/DESCRIPTION’ ... OK
* preparing ‘treePlotArea’:
* checking DESCRIPTION meta-information ... OK
* checking vignette meta-information ... OK
......
......@@ -6,7 +6,7 @@
* building ‘treePlotArea_1.2.0.tar.gz’
Running /home/qwer/svn/R/r-devel/build/bin/R CMD INSTALL \
/tmp/Rtmpf1ZhJt/treePlotArea_1.2.0.tar.gz --install-tests
/tmp/RtmpX5Hesm/treePlotArea_1.2.0.tar.gz --install-tests
* installing to library ‘/home/qwer/svn/R/r-devel/build/library’
* installing *source* package ‘treePlotArea’ ...
** using staged installation
......
R Under development (unstable) (2022-06-23 r82516) -- "Unsuffered Consequences"
R Under development (unstable) (2022-07-29 r82645) -- "Unsuffered Consequences"
Copyright (C) 2022 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)
......@@ -26,23 +26,24 @@ Type 'q()' to quit R.
[1] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/bw2bwi2022de.Rd"
[2] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/select_valid_angle_count_trees.Rd"
[3] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/bwi2cartesian.Rd"
[4] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/trees.Rd"
[5] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/boundaries.Rd"
[6] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_boundary_polygons.Rd"
[7] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_boundary_radius.Rd"
[8] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_correction_factors.Rd"
[9] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_intersection.Rd"
[10] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_r_max.Rd"
[11] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_defaults.Rd"
[12] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/set_options.Rd"
[13] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/orthogonal.Rd"
[14] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/plot_tree_plot_area.Rd"
[15] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/points2equation.Rd"
[16] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/secant_intersections.Rd"
[17] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/throw.Rd"
[18] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/treePlotArea-package.Rd"
[19] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/validate_data.Rd"
[20] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/vector_length.Rd"
[4] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/check_boundaries.Rd"
[5] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/trees.Rd"
[6] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/boundaries.Rd"
[7] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_boundary_polygons.Rd"
[8] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_boundary_radius.Rd"
[9] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_correction_factors.Rd"
[10] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_intersection.Rd"
[11] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_r_max.Rd"
[12] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/get_defaults.Rd"
[13] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/set_options.Rd"
[14] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/orthogonal.Rd"
[15] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/plot_tree_plot_area.Rd"
[16] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/points2equation.Rd"
[17] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/secant_intersections.Rd"
[18] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/throw.Rd"
[19] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/treePlotArea-package.Rd"
[20] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/validate_data.Rd"
[21] "/home/qwer/git/cyclops/fvafrcu/treePlotArea/man/vector_length.Rd"
>
>
......@@ -73,7 +73,7 @@ In addition: Warning messages:
RNGkind: severe deviations from normality for Kinderman-Ramage + Marsaglia-Multicarry
done successfully.
RUNIT TEST PROTOCOL -- Wed Jul 27 16:54:03 2022
RUNIT TEST PROTOCOL -- Fri Jul 29 18:01:53 2022
***********************************************
Number of test functions: 7
Number of errors: 0
......@@ -95,14 +95,14 @@ inst/runit_tests
---------------------------
Test file: inst/runit_tests/runit-get_boundary_polygons.R
test_check_boundaries: (4 checks) ... OK (0.02 seconds)
test_get_boundary_polygons: (2 checks) ... OK (1.57 seconds)
test_get_boundary_polygons: (2 checks) ... OK (1.45 seconds)
---------------------------
Test file: inst/runit_tests/runit-get_boundary_radius.R
test_get_boundary_radius: (1 checks) ... OK (0 seconds)
---------------------------
Test file: inst/runit_tests/runit-get_correction_factors.R
test_get_correction_factor: (1 checks) ... OK (0.03 seconds)
test_get_correction_factors: (2 checks) ... OK (11.9 seconds)
test_get_correction_factors: (2 checks) ... OK (10.96 seconds)
---------------------------
Test file: inst/runit_tests/runit-options.R
test_options: (5 checks) ... OK (0 seconds)
......
......@@ -6,7 +6,7 @@ de An_Introduction_to_treePlotArea.Rnw:44,53
Folge description:3
Forst treePlotArea-package.Rd:23
description:3
grenzkreis NEWS.md:3,39
grenzkreis NEWS.md:5,41
An_Introduction_to_treePlotArea.Rnw:58,63,89
Holzwirtschaftliche treePlotArea-package.Rd:23
description:3
......
......@@ -21,6 +21,6 @@
** testing if installed package keeps a record of temporary installation path
* DONE (treePlotArea)
test_get_boundary_radius.R.... 0 tests test_get_boundary_radius.R.... 0 tests test_get_boundary_radius.R.... 0 tests test_get_boundary_radius.R.... 0 tests test_get_boundary_radius.R.... 1 tests OK 67ms
test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 1 tests OK 1.5s
test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 0 tests test_plot.R................... 1 tests OK 1.4s
test_throw.R.................. 0 tests test_throw.R.................. 1 tests OK 2ms
All ok, 3 results (1.6s)
All ok, 3 results (1.4s)
......
......@@ -8,4 +8,4 @@
* checking for empty or unneeded directories
* building ‘treePlotArea_1.2.0.tar.gz’
✔ [2022-07-28] Check <'fvafrcu@mailbox.org'> for a link to results in 15-30 mins (~11:21 AM).
✔ [2022-07-29] Check <'fvafrcu@mailbox.org'> for a link to results in 15-30 mins (~06:29 PM).
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/check_boundaries.R
\name{check_boundaries}
\alias{check_boundaries}
\title{Check Validity of Boundaries}
\usage{
check_boundaries(x, stop_on_error = TRUE, clean_data = FALSE)
}
\arguments{
\item{x}{A \code{\link{data.frame}} containing boundaries.
It has to have columns named by the contents of
either\cr
\code{\link{get_defaults}("boundaries")} or \cr
\code{fritools::get_options(package_name = "treePlotArea")[["boundaries"]]}.
\cr
Could be
\code{get(data("boundaries", package = "treePlotArea"))}.}
\item{stop_on_error}{Throw an error if invalid boundaries are found?}
\item{clean_data}{Get rid of invalid boundaries?}
}
\value{
A (possibly cleansed) \code{\link{data.frame}} containing boundaries.
}
\description{
There is a boundary (tract 6878, corner 1, boundary 1)in the federal database
for the 2012 survey that runs exactly through the plot. If that boundary
would be valid, at that corner the term "stand" is not defined.
}
\details{
So we check for such boundaries. These are straight boundaries with identical
azimuth values for start and end, and flexed boundaries where azimuth values
for either start or end and the azimuth value for the nook are identical and
the nook is farther away form the plot than the corresponding start or end.
}
\seealso{
Other boundary functions:
\code{\link{get_boundary_polygons}()}
}
\concept{boundary functions}
......@@ -17,7 +17,7 @@ Could be
\code{get(data("boundaries", package = "treePlotArea"))}.}
\item{stop_on_error}{Throw an error if invalid boundaries are encountered?
(There was tract 6878, corner 1, boundary 1 in the federal
(There was tract 6878, corner 1, boundary 1 in the federal
database for the 2012 survey, runs through the plot.
There is no stand defined that way!).}
......@@ -35,3 +35,8 @@ function.
boundaries <- get(data("boundaries", package = "treePlotArea"))
boundary_polygons <- get_boundary_polygons(boundaries)
}
\seealso{
Other boundary functions:
\code{\link{check_boundaries}()}
}
\concept{boundary functions}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment