Skip to content

Commit

Permalink
Add 'Getting Started' section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
alice-hannah committed Nov 15, 2024
1 parent 04e2559 commit 7dfa9a0
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 7dfa9a0

Please sign in to comment.