From 7dfa9a0ad4ffe6130e23966641f7f58e0da536ae Mon Sep 17 00:00:00 2001 From: alice-hannah Date: Fri, 15 Nov 2024 10:43:46 +0000 Subject: [PATCH] Add 'Getting Started' section to README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 3edd069..f2817fb 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,23 @@ remotes::install_local( ) ``` +## Getting Started + +Once installed, objr can be loaded using the `library()` function: + +``` r +library(objr) +``` + +Help files for each function in the package can be found on the +[References](https://ScotGovAnalysis.github.io/objr/reference) page of the package website. Alternatively, type `?function_name` into the +RStudio console. For example: + +``` r +?workspaces() +``` + +There is also a demonstration of a simple workflow using the package in `vignette("objr")`. ## Licence