merging vignettes into a briefer overview

Author: EhrmannS

NEWS.md

@@ -2,14 +2,14 @@
 
 ## New features
 
-- New `bf_analyze()` function for exploring encoding trade-offs. Reports Pareto-optimal exponent/significand configurations per bit count, with quality metrics including RMSE, max error, underflow, overflow, and changed values at a given decimal precision.
+- New `bf_analyze()` function for exploring encoding trade-offs. Reports Pareto-optimal exponent/significand configurations per bit count, with quality metrics including RMSE, max error, underflow, overflow, and changed values at a given decimal precision. Includes a formatted `print()` method with summary header, type-specific output, and ready-to-paste `bf_map()` usage hints.
 - Floating-point encode/decode rewritten from string-based to arithmetic computation, improving performance and correctness.
 - Expanded validation throughout `bf_map()` and `bf_flag()` with more informative error messages.
 
 ## Improvements
 
 - `bf_map()` now uses `template` from the registry instead of requiring explicit `length`/`width` parameters.
-- Vignettes revised and updated (applications vignette removed, best-practices and community-contributions rewritten).
+- Vignettes consolidated into a single "Getting Started" guide covering encoding design, `bf_analyze()`, custom protocols, and community standards.
 - Substantially expanded test suite covering `bf_analyze`, `bf_export`, `bf_protocol`, helpers, and edge cases across all core functions.
 - Documentation updates across all exported and internal functions.
 

R/helpers.R

@@ -1139,7 +1139,7 @@
   if(!is.null(protocol$extends)){
     assertCharacter(x = protocol$extends, pattern = "^([a-zA-Z]+)_(\\d+\\.\\d+\\.\\d+)$")
     matches <- as.character(str_match(protocol$extends, "^([a-zA-Z]+)_(\\d+)\\.(\\d+)\\.(\\d+)$"))
-    assertChoice(x = matches[2], choices = names(bf_pcl))
+    # assertChoice(x = matches[2], choices = names(bf_pcl))
     if(!testCharacter(x = protocol$extends_note, any.missing = FALSE, min.len = 1)) stop("please provide a short note about what this extension changes.")
   }
 

_pkgdown.yml

@@ -13,6 +13,8 @@ reference:
   - title: Main workflow
     desc: These functions make up the core of this package
     contents:
+      - bf_analyze
+      - print.bf_analysis
       - bf_decode
       - bf_encode
       - bf_export