Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.idea/
.Rproj.user
*.html
hakaiApi/docs/*.html
!hakaiApi/pkgdown/templates/navbar.html
11 changes: 6 additions & 5 deletions hakaiApi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ This project exports a single R6 class for the R programming language that can b

## Installation

Before using this library, install it into your environment using one of the following in your R script:
You can install hakaiApi from CRAN:

```r
# From CRAN
install.packages("hakaiApi")
```

Or install the latest version from the Hakai Institute r-universe server:

# OR, the latest version from GitHub
install.packages("remotes")
remotes::install_github("HakaiInstitute/hakai-api-client-r", subdir='hakaiApi')
```r
install.packages("hakaiApi", repos = "https://hakaiinstitute.r-universe.dev")
```

## Quickstart
Expand Down
6 changes: 6 additions & 0 deletions hakaiApi/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
url: https://hakaiinstitute.github.io/hakai-api-client-r/
template:
bootstrap: 5
bootswatch: flatly
bslib:
primary: "#aa2025"
link-color: "#aa2025"
navbar-bg: "#2c3e50"
navbar-dark: true

Binary file added hakaiApi/pkgdown/assets/hakai.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions hakaiApi/pkgdown/templates/navbar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{{#navbar}}
<nav class="navbar navbar-expand-lg fixed-top {{#bg}}bg-{{{.}}}{{/bg}}" {{#type}}data-bs-theme="{{{.}}}"{{/type}} aria-label="{{#translate}}{{site_nav}}{{/translate}}">
<div class="container">
{{#includes}}{{{before_title}}}{{/includes}}
<a class="navbar-brand me-2" href="{{#site}}{{root}}{{/site}}index.html">{{#site}}{{title}}{{/site}}</a>

<small class="nav-text {{#development}}text-{{version_label}}{{/development}} me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="{{#development}}{{version_tooltip}}{{/development}}">{{#package}}{{version}}{{/package}}</small>

{{#includes}}{{{before_navbar}}}{{/includes}}
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="{{#translate}}{{toggle_nav}}{{/translate}}">
<span class="navbar-toggler-icon"></span>
</button>

<div id="navbar" class="collapse navbar-collapse ms-3">
{{#left}}
<ul class="navbar-nav me-auto">
{{{.}}}
</ul>
{{/left}}

{{#right}}
<ul class="navbar-nav">
{{{.}}}
</ul>
{{/right}}
</div>

<a href="https://www.hakai.org" target="_blank" rel="noopener" class="ms-2">
<img src="{{#site}}{{root}}{{/site}}hakai.png" alt="Hakai Institute" height="28">
</a>

{{#includes}}{{{after_navbar}}}{{/includes}}
</div>
</nav>
{{/navbar}}
Loading