inst/reports/region2/gdb-acreage/README.md

In ncss-tech/soilReports: R Markdown Reports and Convenience Functions for Soil Survey

minimal soilReports template

This report has {aqp}, {soilDB} and {sharpshootR} off CRAN and GitHub as dependencies. It makes a couple simple graphics from the {soilDB} documentation.

The input vectors of soil names for fetching OSDs etc. are customizable in config.R.

To use the report:

1. Navigate to your desired parent working directory.

2. Run soilReports::reportSetup("templates/minimal") to install dependencies

3. Run soilReports::reportInit("templates/minimal", outputDir = "minimal-test") to install a report instance in outputDir. Specify overwrite argument as needed. Use reportUpdate if an existing older report instance is being updated and you want to preserve config.R contents.

4. Navigate to "minimal-test" directory and inspect report contents. Open report.Rmd in RStudio and click "Knit" button, or render() with {rmarkdown} manually.

Core Report Components

• setup.R - used internally by {soilReports}, must be defined in inst/reports/ folder for each report. Defines dependencies and manifest of files that are copied to user file system.

• report.Rmd - main report document

• config.R - user-level configuration and options; should not be over-written by reportUpdate

• NEWS.md - Changelog (optional)

• README.md - Narrative and free-form description of report (rendered by GitHub as "index" for each folder; optional)

ncss-tech/soilReports documentation built on Oct. 12, 2024, 4:39 a.m.