output: github_document

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
version <- as.vector(read.dcf('DESCRIPTION')[, 'Version'])
version <- gsub('-', '.', version)                          

Project Status: Active – The project has reached a stable, usable state and is being actively developed. packageversion Last-changedate

Utility

soiltestr is built to help collect and analyze laboratory soil test data. I wrote the functions for my own use, but other soil scientists may find them of value. The code streamlines commonly performed tests: particle size analysis, Atterberg limits, Proctor maximum density, and particle density (specific gravity).

This package is currently under heavy development and likely will be rather opaque to new users. However, I plan to streamline the documentation and release it to CRAN.

Installation

A binary version of soiltestr is not yet available on CRAN. Install the development version with the following command:

remotes::install_github("evanmascitti/soiltestr")

Functions

Below are one-line overviews of each function's purpose:

Data analysis

add_w(): Calculate gravimetric water content and add to an existing data frame

add_physical_properties() Compute various metrics from raw Proctor data

proctor_prep(): Specimen preparation for Proctor compaction tests

proctor_fit(): Fit a compaction curve to compute wopt and ρmax

d_max() Fit a compaction curve and compute the maximum density only.

w_opt() Fit a compaction curve and compute the optimum water content only.

compute_LL() calculate the liquid limit from water contents and blow counts

LL_batch_analysis() calculate liquid limit of all specimens tested in a batch

PL_batch_analysis() calculate plastic limit of all specimens tested in a batch

AL_batch_analysis() calculate adhesion limit of all specimens tested in a batch

pipette_analysis() analyze pipette and sieve data for one or more samples

Visualization

ggproctor() plotting compaction curves with ggplot2

ggflowcurve() plotting liquid limit data with ggplot2

casagrande_chart() display Atterberg limits on the traditional LL vs PI scatterplot, with U-line and A-line plotted

ggpsd() plot one or more particle size distributions

ggpsd_single_sample() plot particle size distributions for a single specimen

ggphase_diagram() plot solid, liquid, and gaseous phases of a sand-clay mix

Data managmement and reference sheets

mix_calcs(): Precise calculations for sand-clay soil mixtures

Populate skeleton .csv files for data collection (function names self-explanatory)

generate_proctor_datasheet()

pipette_datasheets() creates .csv data sheets for the different types of data required in this analysis

att_lims_datasheets() creates .csv data sheets for liquid, adhesion, and plastic limit tests

Standard method references

The standardized soil tests which may be deployed using this package include:

Particle size analysis

Proctor compaction

Atterberg limits



evanmascitti/soiltestr documentation built on Oct. 6, 2022, 5:32 p.m.