Skip to content

Commit

Permalink
Vignette update
Browse files Browse the repository at this point in the history
Vignette updated to include new Meta folder
  • Loading branch information
japilo committed Oct 13, 2022
1 parent ff3ba58 commit 4c825e8
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 18 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@
^LICENSE\.md$
^cran-comments\.md$
^CRAN-RELEASE$
^CRAN-SUBMISSION$
^doc$
^Meta$
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,5 @@ vignettes/*.pdf
.Renviron
.Rproj.user
inst/doc
/doc/
/Meta/
14 changes: 4 additions & 10 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
# Test environments

- Local R 4.2.1 installation on Windows 10
- R-devel, Windows, via Rhub
- Local R 4.2.1 installation on Windows 10
- R-devel, Windows, via Rhub
- Ubuntu Linux 20.04.1 LTS, R-release, GCC, via Rhub
- Platform: Fedora Linux, R-devel, clang, gfortran, via Rhub
- Fedora Linux, R-devel, clang, gfortran, via Rhub

# R CMD check results

0 errors ✔ \| 0 warnings ✔ \| 1 note

Possibly misspelled words in DESCRIPTION:
Paleo (4:9)
paleontological (18:67)

These words are not misspelled and are commonplace in the ecology discipline, which this package is intended for.
0 errors ✔ \| 0 warnings ✔ \| 0 notes
12 changes: 4 additions & 8 deletions vignettes/bison_example.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -361,19 +361,15 @@ error messages for failed calculations.

Now that we've calculated some summary metrics, based on outputs from
`PaleoPopResults` like extinction time and abundance trend, we can
examine the simulation results.
examine the simulation results. Here I show the simulated extinction times.

```{r histograms, fig.align = "center", fig.width = 7, fig.height = 5}
hist(metrics_manager$summary_metric_data$abundance_trend,
main = "Histogram of abundance trend", xlab = "Abundance trend")
hist(metrics_manager$summary_metric_data$extinction_time,
main = "Histogram of extinction time", xlab = "Extinction time (years BP)")
metrics_manager$summary_metric_data$extinction_time
```

Looking at these results, both of these summary metrics, abundance trend
Both of these summary metrics, abundance trend
over the first ten time steps and extinction time, could be a suitable
metric to converge toward a validation target, since there is a spread
of outcomes.
metric to converge toward a validation target.

From here, you may continue with the `poems` workflow, as explained in
the `poems`
Expand Down

0 comments on commit 4c825e8

Please sign in to comment.