Found 24 bookmarks
Newest
Documenting functions
Documenting functions
The basics of roxygen2 tags and how to use them for documenting functions.
Examples @examples provides executable R code showing how to use the function in practice. This is a very important part of the documentation because many people look at the examples before reading anything. Example code must work without errors as it is run automatically as part of R CMD check. For the purpose of illustration, it’s often useful to include code that causes an error. You can do this by wrapping the code in try() or using \dontrun{} to exclude from the executed example code. For finer control, you can use @examplesIf: #' @examplesIf interactive() #' browseURL("https://roxygen2.r-lib.org")
Instead of including examples directly in the documentation, you can put them in separate files and use @example path/relative/to/package/root to insert them into the documentation. All functions must have examples for initial CRAN submission.
RR#r#r-development#r-package-devt#r-project#dev#r-package#development
·roxygen2.r-lib.org·
Documenting functions
Getting Started with Julia for Actuaries
Getting Started with Julia for Actuaries
An overview of the basic tooling and packages available for the Julia programming language, with a focus on why this is of interest to the actuarial profession. It covers some of the built-in language features as well parts of the Julia package ecosystem that make Julia ideal for modeling and data analysis. This is the second installment in a series of article aimed at actuaries. The first installment, Julia for Actuaries, was published in the October 2020 edition of Actuarial Technology Today, and covered the base language itself, its high-level, math-friendly syntax, and why the actuary of the future should consider its adoption.
Actuarial ScienceActuarial Science#Development#Julia#actuarial#programming
·soa.org·
Getting Started with Julia for Actuaries