Functions that are deprecated should be documented in a similar way:
[ ] lifecycle tag - deprecated or superseded.
[ ] title and description: (Deprecated) - as done in align_pca.R.
[ ] description: explain rationale for deprecation and what function takes over, if any, with a direct link to the latter. If possible, provide an example of how the same functionality can be obtained through the function that replaces it.
[ ] Add a document where this process is documented (for the future).
Functions that are deprecated should be documented in a similar way: