add development section

R/read_smips.R

@@ -169,6 +169,7 @@ read_smips <- function(collection = "totalbucket",
 
   if (.collection == "totalbucket" &&
       .url_year < 2005 ||
+      # NOTE: this is throwing "'tzone' attributes are inconsistent"
       .day > .last_week) {
     cli::cli_abort("The data are not available before 2005 and roughly
                    much past { .last_week }")

README.Rmd

@@ -17,7 +17,7 @@ knitr::opts_chunk$set(
 
 <!-- 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](https://codecov.io/gh/AAGI-AUS/nert/graph/badge.svg?token=WgBeTrqQnQ)](https://codecov.io/gh/AAGI-AUS/nert)
 <!-- badges: end -->
 
 The goal of {nert} is to provide access to Australian TERN (Terrestrial Ecosystem Research Network) data in your R session.
@@ -38,18 +38,20 @@ pak::pak("AAGI-AUS/nert")
 
 This is a basic example which shows you how you can fetch one day's data from the SMIPS data (currently the only supported data set in TERN) and visualise it:
 
-```{r example_cog}
+```{r example_cog, eval=FALSE}
 library(nert)
 r <- read_smips(day = "2024-01-01")
 
 plot(r)
 ```
 
+![example plot](./man/figures/README-example_cog-1.png)
+
 ## Extract Values Given Lat/Lon Values
 
 Extract Soil Moisture for Corrigin and Merriden, WA and Tamworth, NSW given latitude and longitude values for each.
 
-```{r}
+```{r, eval=FALSE}
 library(terra)
 df <- structure(
   list(
@@ -66,4 +68,30 @@ cog_df <- extract(x = r, y = df[, c("x", "y")], xy = TRUE)
 cog_df <- cbind(df$location, cog_df)
 names(cog_df) <- c("location", "ID", "smips_totalbucket_mm_20240101", "x", "y")
 cog_df
+#>   location ID smips_totalbucket_mm_20240101        x         y
+#> 1 Corrigin  1                    0.06715473 117.8688 -32.33328
+#> 2 Merredin  2                    0.22716530 118.2787 -31.48353
+#> 3 Tamworth  3                   93.44989014 150.8408 -31.07365
+```
+
+## Development
+
+### Dev Container
+
+Set up the container.
+
+```{bash, eval=FALSE}
+devcontainer up --workspace-folder .
+```
+
+Run tests and check stuff.
+
+```{bash, eval=FALSE}
+devcontainer exec --workspace-folder . R -e "devtools::check()"
+```
+
+Render this file.
+
+```{bash, eval=FALSE}
+devcontainer exec --workspace-folder . R -e "devtools::build_readme()"
 ```

README.md

@@ -6,8 +6,7 @@
 <!-- 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](https://codecov.io/gh/AAGI-AUS/nert/graph/badge.svg?token=WgBeTrqQnQ)](https://codecov.io/gh/AAGI-AUS/nert)
 <!-- badges: end -->
 
 The goal of {nert} is to provide access to Australian TERN (Terrestrial
@@ -34,20 +33,15 @@ visualise it:
 
 ``` r
 library(nert)
-#> 
-#> Attaching package: 'nert'
-#> The following object is masked from 'package:graphics':
-#> 
-#>     plot
-#> The following object is masked from 'package:base':
-#> 
-#>     plot
 r <- read_smips(day = "2024-01-01")
 
 plot(r)
 ```
 
-<img src="man/figures/README-example_cog-1.png" width="100%" />
+<figure>
+<img src="./man/figures/README-example_cog-1.png" alt="example plot" />
+<figcaption aria-hidden="true">example plot</figcaption>
+</figure>
 
 ## Extract Values Given Lat/Lon Values
 
@@ -56,7 +50,6 @@ given latitude and longitude values for each.
 
 ``` r
 library(terra)
-#> terra 1.7.83
 df <- structure(
   list(
     location = c("Corrigin", "Merredin", "Tamworth"),
@@ -77,3 +70,25 @@ cog_df
 #> 2 Merredin  2                    0.22716530 118.2787 -31.48353
 #> 3 Tamworth  3                   93.44989014 150.8408 -31.07365
 ```
+
+## Development
+
+### Dev Container
+
+Set up the container.
+
+``` bash
+devcontainer up --workspace-folder .
+```
+
+Run tests and check stuff.
+
+``` bash
+devcontainer exec --workspace-folder . R -e "devtools::check()"
+```
+
+Render this file.
+
+``` bash
+devcontainer exec --workspace-folder . R -e "devtools::build_readme()"
+```