Skip to content

Restore the mv vignette and add NEWS/README entries for the multivariate / MFPCA / shape-registration features #258

@fabian-s

Description

@fabian-s

The 1,072-line vignette attic/vector-valued-functions.Rmd was written, polished over many commits (bibliography, MFPCA case study, registration ladder, quotient-space demo), and then moved to attic. The flagship feature of the current release ships with:

  • no long-form documentation
  • no NEWS section (only the parenthetical (now includes tfb_mfpc()) inside the 0.4.2 entry)
  • no README mention

Roughly 30 exports and a third of R/ are currently undocumented at the "why would I use this" level.

Fix

  1. Restore vignettes/vector-valued-functions.Rmd. If runtime is the concern, precompute the slow fdasrvf chunks via R.rsp precompute or the standard *.Rmd.orig pattern.
  2. Add NEWS.md section for the next release: "Vector-valued functional data" with subsections covering tfd_mv/tfb_mv classes, tfb_mfpc() MFPCA, mv registration (method = "srvf_mv", tf_register_shape()), the new geometry verbs (tf_norm, tf_inner, tf_tangent, tf_arclength).
  3. README.Rmd: a short paragraph + one example. Mention is_tf() now matches tf_mv too — important for downstream code (this is a silent contract change).
  4. Update _pkgdown.yml if needed (cross-checked already by the review — index is complete).

Found in the June-2026 ground-up review. Release blocker.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions