In bcgov/BCForestGroundSample: BC forest ground sample compilation

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)

BCForestGroundSample hosts functions for compiling forest ground sample data. Currently, it supports the functions used in VRI Compiler. It Will incorporate PSP compiler soon.

Package Status

This package is still under development.

Development History and Features

version 1

Date: To March 1st, 2018

Features:

• clarified the unnecessary process in SAS compiler
• implemented mid-point guess in height estimate for broken top trees
• added lorey's height estimate in height summary
• added tree flag for
  • full measured trees (DBH + Height + Call grading available)
  • enhanced trees in auxi plot (DBH + Height + Call grading available)
  • height enhanced trees (DBH + Height available)
  • non-enhanced trees (DBH available)
• outputed data for deriving regression and ratio
• hard-coded lookup tables (SAS compiler reads these tables)
• solved floating point issues (SAS compiler does not take account)

version 2

Date: To November 21, 2018

Features:

• specified trees in B type plot as H enhanced trees, as their call grading information is not available
• introduced SIndexR package to remove the sas-dependency of sindexdll

Issue/Bug Reporting

Please file an issue, if you encounter.

Install package

The package is only can be installed and ran in 64-bit R. Because the package is built on a 64-bit R and 64-bit ROracle client.

To install our package, ROracle package must be present in your R environment. Installation of \code{ROracle} is tricky, as it involves the following steps:

• Install a 64-bit Oracle client on your machine if it is not available. A 64-bit Oracle client can be downloaded here;
• Download an ROracle from CRAN on here;
• Open CMD prompt and make some specifications
  • set PATH=C:\oracle\product\11.2.0\client_2\BIN;%PATH%
  • set OCI_LIB64=C:\oracle\product\11.2.0\client_2\BIN
  • set OCI_INC=C:\oracle\product\11.2.0\client_2\oci\include
• Install ROracle in CMD prompt using
  • C:/PROGRA.1/R/R-3.1.1/bin/x64/R" CMD INSTALL --build "C:/Your/Path/To/ROracle_1.1-10.tar.gz

Once ROralce is installed, our package can be installed from github by using following codes:

library(devtools)
options(devtools.install.args = "--no-multiarch")
## install from development branch 
install_github("bcgov/BCForestGroundSample", ref = "development")
## install from master branch (stable)
install_github("bcgov/BCForestGroundSample")

Warning messages may be showed up when you install the package. However, it should not affect outputs of each function. If you have any concerns about the package, please report your issue here.

Use package

The below codes demonstrate some examples use the functions in this package:

Contribute to the package

If you would like to contribute to the package, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Licence

# Copyright 2018 Province of British Columbia
# 
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
# http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and limitations under the License.

bcgov/BCForestGroundSample documentation built on May 25, 2019, 3:21 p.m.