Skip to content

Commit

Permalink
Update README and add pkgdown infra
Browse files Browse the repository at this point in the history
  • Loading branch information
adamhsparks committed Nov 1, 2024
1 parent a920b7b commit a9d9611
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 15 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
^.*\.Rproj$
^\.Rproj\.user$
^codecov\.yml$
^_pkgdown\.yml$
^docs$
^pkgdown$
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
.httr-oauth
.DS_Store
.quarto
docs
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ knitr::opts_chunk$set(
[![Codecov test coverage](https://codecov.io/gh/AAGI-AUS/nert/graph/badge.svg)](https://app.codecov.io/gh/AAGI-AUS/nert)
<!-- badges: end -->

The goal of {nert} is to provide access to Australian TERN (Terrestrial Ecosystem Research Network) data.
The goal of {nert} is to provide access to Australian TERN (Terrestrial Ecosystem Research Network) data in your R session.

## Installation

Expand Down
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->



# nert

<!-- badges: start -->

[![R-CMD-check](https://github.com/AAGI-AUS/nert/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/AAGI-AUS/nert/actions/workflows/R-CMD-check.yaml)
[![Codecov test
coverage](https://codecov.io/gh/AAGI-AUS/nert/graph/badge.svg)](https://app.codecov.io/gh/AAGI-AUS/nert)
[![Codecov test coverage](https://codecov.io/gh/AAGI-AUS/nert/graph/badge.svg)](https://app.codecov.io/gh/AAGI-AUS/nert)
<!-- badges: end -->

The goal of {nert} is to provide access to Australian TERN (Terrestrial
Ecosystem Research Network) data.
The goal of {nert} is to provide access to Australian TERN (Terrestrial Ecosystem Research Network) data in your R session.

## Installation

You can install the development version of {nert} from
[GitHub](https://github.com/AAGI-AUS/nert) with:
You can install the development version of {nert} from [GitHub](https://github.com/AAGI-AUS/nert) with:


``` r
if (!require("pak")) {
Expand All @@ -25,17 +27,17 @@ if (!require("pak")) {
#> Loading required package: pak

pak::pak("AAGI-AUS/nert")
#> ℹ Loading metadata database
#> ✔ Loading metadata database ... done
#>
#>
#> Found 1 deps for 0/1 pkgs [⠋] Resolving AAGI-AUS/nert Found 1 deps for 0/1 pkgs [⠙] Resolving AAGI-AUS/nert Found 1 deps for 0/1 pkgs [⠹] Resolving AAGI-AUS/nert Found 1 deps for 0/1 pkgs [⠸] Resolving AAGI-AUS/nert Found 1 deps for 0/1 pkgs [⠼] Resolving AAGI-AUS/nertℹ Loading metadata database ✔ Loading metadata database ... done
#> Found 1 deps for 0/1 pkgs [⠼] Resolving AAGI-AUS/nert Found 7 deps for 1/1 pkgs [⠴] Checking installed packages Found 7 deps for 1/1 pkgs [⠦] Checking installed packages Found 7 deps for 1/1 pkgs [⠧] Resolving standard (CRAN/BioC) packages
#> ℹ No downloads are needed
#> ✔ 1 pkg + 8 deps: kept 8 [3.1s]
#> Installing... ✔ 1 pkg + 8 deps: kept 8 [4.6s]
```

## Example

This is a basic example which shows you how you can fetch one days data
and visualise it:
This is a basic example which shows you how you can fetch one day's data and visualise it:


``` r
library(nert)
Expand All @@ -52,4 +54,7 @@ r <- get_smips(day = "2024-01-01")
plot(r)
```

<img src="man/figures/README-example-1.png" width="100%" />
<div class="figure">
<img src="man/figures/README-example-1.png" alt="plot of chunk example" width="100%" />
<p class="caption">plot of chunk example</p>
</div>
Expand Down
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: ~
template:
bootstrap: 5

Binary file modified man/figures/README-example-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a9d9611

Please sign in to comment.