Merge pull request #364 from weecology/devdocs

minor doc edits

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: portalcasting
 Title: Model and Forecast Portal Rodent Dynamics
-Version: 0.60.0
+Version: 0.60.1
 Authors@R: c(
     person(c("Juniper", "L."), "Simonis",
       email = "[email protected]", role = c("aut", "cre"),

NEWS.md

@@ -2,6 +2,11 @@
 
 Version numbers follow [Semantic Versioning](https://semver.org/).
 
+# [portalcasting 0.60.1](https://github.com/weecology/portalcasting/releases/tag/v0.60.1)
+*5-22-2023*
+
+## Minor doc edits
+
 # [portalcasting 0.60.0](https://github.com/weecology/portalcasting/releases/tag/v0.60.0)
 *5-19-2023*
 
@@ -12,16 +17,16 @@ Version numbers follow [Semantic Versioning](https://semver.org/).
 # [portalcasting 0.59.0](https://github.com/weecology/portalcasting/releases/tag/v0.59.0)
 *5-18-2023*
 
-## Inclduing curl in the Dockerfile
-* thought it was installed, but it isnt in tidyverse, just verse
+## Including curl in the Dockerfile
+* thought it was installed, but it isn't in tidyverse, just verse
 
 # [portalcasting 0.58.0](https://github.com/weecology/portalcasting/releases/tag/v0.58.0)
 *5-18-2023*
 
 ## Editing documentation
-* Auto templates for issues and prs 
+* Auto templates for issues and PRs 
 
-## Inclduing git2r in the package
+## Including git2r in the package
 * Was removed accidentally from dockerfile causing breaks in main repo, seeing if it works to be in the package itself
 
 # [portalcasting 0.57.0](https://github.com/weecology/portalcasting/releases/tag/v0.57.0)
@@ -1049,8 +1054,8 @@ the forecast date with a time stamp as well.
 * Developed this changelog as part of the package.
 
 ## Support documents
-* Added [code of conduct](https://github.com/weecology/portalcasting/blob/master/CODE_OF_CONDUCT.md) 
-and [contribution guidelines](https://github.com/weecology/portalcasting/blob/master/CONTRIBUTING.md)
+* Added [code of conduct](https://github.com/weecology/portalcasting/blob/main/.github/CODE_OF_CONDUCT.md) 
+and [contribution guidelines](https://github.com/weecology/portalcasting/blob/main/.github/CONTRIBUTING.md)
 to the repository.
 
 # [portalcasting 0.1.1](https://github.com/weecology/portalcasting/commit/05ed76f76a82f32a5a3120eb7c9ef0dc95bd8ae4)

README.md

@@ -4,7 +4,7 @@
 
 [![R-CMD-check](https://github.com/weecology/portalcasting/actions/workflows/r-cmd-check.yaml/badge.svg)](https://github.com/weecology/portalcasting/actions/workflows/r-cmd-check.yaml)
 [![Docker](https://github.com/weecology/portalcasting/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/weecology/portalcasting/actions/workflows/docker-publish.yml)
-[![Codecov test coverage](https://img.shields.io/codecov/c/github/weecology/portalcasting/main.svg)](https://codecov.io/github/weecology/portalcasting/branch/main)
+[![Codecov test coverage](https://img.shields.io/codecov/c/github/weecology/portalcasting/main.svg)](https://app.codecov.io/github/weecology/portalcasting/branch/main)
 [![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html)
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/weecology/portalPredictions/master/LICENSE)
@@ -34,8 +34,7 @@ We leverage a [software container](https://en.wikipedia.org/wiki/Operating-syste
 Presently, we use a [Docker](https://hub.docker.com/r/weecology/portalcasting) image of the software environment to create a container for running the code. 
 The image is automatically rebuilt when there is a new `portalcasting` release, tagged with both the `latest` and version-specific (`vX.X.X`) tags, and pushed to [DockerHub](https://hub.docker.com/r/weecology/portalcasting). 
 
-Because the `latest` image is updated with releases, the current master branch code in `portalcasting` is not necessarily always being executed within the [predictions repository](https://github.com/weecology/portalPredictions). 
-A development image (`dev`) is built from the master branch of `portalcasting` at every push to facilitate testing and should not be considered stable.
+Because the `latest` image is updated with releases, the current main branch code in `portalcasting` is typically, but not necessarily always, being executed within the [predictions repository](https://github.com/weecology/portalPredictions). 
 
 The API is moderately well defined at this point, but is still evolving.
 
@@ -62,14 +61,14 @@ from a shell on a computer with [Docker](https://www.docker.com/) installed.
 
 Get started with the ["how to set up a Portal Predictions directory" vignette](https://weecology.github.io/portalcasting/articles/getting_started.html).
 
-If you are interested in adding a model to the preloaded [set of models](https://weecology.github.io/portalcasting/articles/current_models.html), see the ["adding a model" vignette](https://weecology.github.io/portalcasting/articles/adding_model_and_data.html). 
+If you are interested in adding a model to the preloaded [set of models](https://weecology.github.io/portalcasting/articles/current_models.html), see the ["adding a model and data" vignette](https://weecology.github.io/portalcasting/articles/adding_model_and_data.html). That document also details how to expand the datasets available to new and existing models.
 
 
 ## Developer and Contributor notes
 
 We welcome any contributions in form of models or pipeline changes.  
 
-For the workflow, please checkout the [contribution](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md) pages. 
+For the workflow, please checkout the [contribution](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md) pages. 
 
 
 ## Acknowledgements

inst/WORDLIST

@@ -39,6 +39,7 @@ NMME
 NaN
 NaiveArima
 ORCID
+PRs
 Plummer
 PortalData
 README
@@ -69,6 +70,7 @@ dataset's
 dev
 dir
 dockerfile
+dockerhub
 dontrun
 downscaled
 dplyr
@@ -131,6 +133,7 @@ se
 shinyapp
 subfolders
 summarization
+tidyverse
 timeseries
 tscount
 tsglm