CRAN resubmission fixes for 1.4.1

[JustinMShea]

CRAN resubmission fixes for version 1.4.0

CRAN requested several documentation, example, console-output, and file-writing corrections before FinancialInstrument can be resubmitted.

Compatibility requirement

This maintenance release must preserve the existing public API wherever possible.

• Do not rename or remove exported functions.
• Do not reorder existing arguments.
• Add new arguments only at the end of existing signatures.
• Preserve behavior for existing calls that supply valid explicit inputs and paths.
• Avoid changing return classes or object structures.
• Limit behavioral changes to cases specifically required for CRAN compliance.
• Add regression tests before modifying public behavior.
• Document any unavoidable behavior change in NEWS and the re-submission notes.

DESCRIPTION

• Clarify request for DOI or ISBN

Return-value documentation

• Audit all exported-function manuals missing \value.
• Add corresponding @return tags to the roxygen source.
• Describe the output class and structure.
• Explain what the returned value represents.
• Document side-effect-only functions explicitly.
• Regenerate the .Rd files.

Examples

• Fix the unmatched parenthesis in the ls_by_currency() example.
• Remove commented-out executable code from examples.
• Replace unnecessary \dontrun{} blocks with executable examples or \donttest{}.
• Keep \dontrun{} only for genuinely unexecutable examples.
• Use tempfile() or tempdir() for examples that write files.
• Restore any modified instrument registry state after examples.

Namespace and internal-object access

• Remove FinancialInstrument:::.instrument from documentation examples.
• Replace direct internal-registry access with exported package functions.
• Confirm that expires() is exported in the generated NAMESPACE.
• Remove examples for genuinely unexported functions or export them only when they are intended public API.

Console output

• Audit R/Tick2Sec.R for unconditional cat() or print() calls.
• Make informational progress output suppressible.
• Prefer message() for optional progress reporting.
• Add verbose = FALSE only at the end of an existing function signature.
• Preserve existing results and return values.

File-writing behavior

• Identify functions, tests, and examples that write to the working directory or home directory by default.
• Correct examples and tests to use temporary directories.
• Avoid changing public function defaults unless necessary to satisfy CRAN.
• For any unavoidable default-path change, preserve existing explicit-path calls.
• Add regression tests covering explicit output paths.
• Document any unavoidable behavior change.

Verification

• Regenerate documentation with roxygen2.
• Confirm all exported-function manuals contain \value.
• Confirm generated documentation contains no unintended :::.
• Confirm examples contain no commented-out executable alternatives.
• Run the complete tinytest suite.
• Run R CMD build.
• Run R CMD check --as-cran.
• Run R CMD check --as-cran --run-donttest.
• Run Win-builder release.
• Run Win-builder devel.
• Update cran-comments.md.
• Submit version 1.4.1 to CRAN.

[JustinMShea]

Implementation and verification for FinancialInstrument 1.4.1 are complete.

Completed:

• Clarified that no DOI or ISBN applies
• Added missing return-value documentation
• Regenerated the Rd files and NAMESPACE
• Corrected broken examples
• Removed commented-out executable example alternatives
• Replaced unnecessary \dontrun{} sections
• Updated file-writing examples to use temporary directories
• Removed FinancialInstrument:::.instrument from documentation examples
• Confirmed that expires() is exported
• Restored and tested the exported rm_by_currency() API
• Made alltick2sec() progress output suppressible
• Removed fixed home-directory defaults from alltick2sec()
• Added regression tests
• Ran the tinytest suite
• Ran R CMD build
• Ran R CMD check --as-cran
• Ran R CMD check --as-cran --run-donttest
• Ran win-builder release and devel checks
• Added blotter and quantstrat reverse-dependency checks
• Updated cran-comments.md

Final check result:

0 errors | 0 warnings | 1 expected archive NOTE

The remaining task is to submit FinancialInstrument 1.4.1 to CRAN. This issue will remain open until the submission is accepted.