Package index • grainsizeR

Input and validation

read_gsd(): Read grain-size data from a delimited text file
read_gsd_wide(): Read wide-format grain-size data from a CSV file
as_gsd_tbl(): Convert long-format grain-size data to a gsd_tbl
is_gsd_tbl(): Test whether an object is a grain-size distribution tibble
validate_gsd_tbl(): Validate a grain-size distribution tibble
gs_diagnostics(): Diagnose grain-size data quality and resolvability

Unit conversion

mm_to_um(): Convert millimeters to micrometers
um_to_mm(): Convert micrometers to millimeters
mm_to_phi(): Convert millimeters to phi units
phi_to_mm(): Convert phi units to millimeters
um_to_phi(): Convert micrometers to phi units
phi_to_um(): Convert phi units to micrometers

Cumulative curves and D-values

gs_cumulative(): Build cumulative grain-size boundary curves
gs_d_values(): Calculate grain-size percentiles
gs_percent_finer(): Calculate percent finer than grain-size thresholds
gs_d_spread(): Calculate GRADISTAT-style D-spread descriptors

Grain-size indices

gs_grain_size_indices(): Calculate additional grain-size indices
gs_parameters(): Summarize grain-size parameters
gs_describe_parameters(): Attach GRADISTAT-style parameter descriptions
gs_desc(): Convenience alias for descriptive parameter terms
gs_quality_flags(): Report GRADISTAT-inspired quality flags
gs_qc(): Convenience alias for grain-size quality flags
gs_size_terms(): Describe grain-size terms
gs_modes(): Identify modal grain-size classes

Folk and Ward statistics

gs_folk_ward(): Calculate Folk and Ward graphical grain-size statistics
gs_fw57(): Convenience alias for Folk and Ward graphical statistics
describe_kurtosis_fw(): Describe Folk and Ward kurtosis
describe_mean_size_phi(): Describe mean grain size from phi units
describe_skewness_fw(): Describe Folk and Ward skewness
describe_sorting_fw(): Describe Folk and Ward sorting

Moment statistics

gs_moments(): Calculate grain-size moment statistics

Fractions and particle-size systems

particle_size_systems(): List built-in particle-size boundary systems
texture_source_audit(): Inspect the texture source audit registry
gs_fraction_schemes(): List built-in grain-size fraction schemes
gs_frac_schemes(): Convenience alias for fraction schemes
gs_fractions(): Calculate grain-size fraction percentages
gs_frac(): Convenience alias for grain-size fractions
gs_fractions_wide(): Calculate grain-size fraction percentages in wide form
gs_frac_wide(): Convenience alias for wide grain-size fractions

Texture polygons and classification

texture_polygon_sources(): List planned texture polygon source registries
texture_polygon_template(): Create an empty texture polygon template
texture_polygon_reconstruction_template(): Create an empty texture polygon reconstruction template
reconstruction_to_texture_polygons(): Convert a reconstruction table to texture polygons
validate_texture_polygons(): Validate user-supplied texture polygons
classify_texture(): Classify samples with texture classes
gs_gradistat_sediment_name(): Compose GRADISTAT-style sediment names
ternary_to_xy(): Convert ternary coordinates to Cartesian coordinates

Plotting

plot_distribution(): Plot retained grain-size distributions
plot_cumulative(): Plot cumulative grain-size curves
plot_fractions(): Plot grain-size fraction composition
plot_gradistat_summary(): Plot a GRADISTAT-inspired grain-size summary
plot_texture_triangle(): Compatibility alias for texture ternary plots
plot_texture_ternary(): Plot samples on a texture ternary plot

Compatibility aliases

gs_percentile(): Calculate grain-size percentiles
gs_engineering(): Calculate additional grain-size indices
gs_folkward(): Calculate Folk and Ward graphical grain-size statistics
gs_diag(): Convenience alias for grain-size diagnostics
plot_trigon(): Plot samples on a ternary diagram