diff --git a/.Rbuildignore b/.Rbuildignore
index d88f69c..7ad4a01 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -10,3 +10,5 @@
^codecov\.yml$
^cran-comments\.md$
^CRAN-RELEASE$
+^vignettes/articles$
+^_pkgdown\.yml$
diff --git a/.github/workflows/on-release.yml b/.github/workflows/on-release.yml
new file mode 100644
index 0000000..6dfbd69
--- /dev/null
+++ b/.github/workflows/on-release.yml
@@ -0,0 +1,28 @@
+name: on-release
+
+on:
+ release:
+ types: [published]
+
+jobs:
+ build:
+ runs-on: macos-latest
+ steps:
+ - uses: actions/checkout@v2
+ with:
+ ref: latest-release
+ persist-credentials: false
+ fetch-depth: 0
+ - name: Configure git
+ run: |
+ git config --local user.email "noreply@github.com"
+ git config --local user.name "GitHub"
+ - name: Fast forward
+ run: |
+ echo "the tag is ${{ github.ref_name }}"
+ git merge --ff-only ${{ github.ref_name }}
+ - name: Push
+ uses: ad-m/github-push-action@master
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ branch: latest-release
diff --git a/DESCRIPTION b/DESCRIPTION
index 509fc27..08a33bc 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -58,9 +58,13 @@ Imports:
tidyr
Suggests:
covr,
+ cowplot,
+ here,
+ hexSticker,
knitr,
purrr,
rmarkdown,
+ showtext,
testthat
VignetteBuilder:
knitr
diff --git a/LICENSE.md b/LICENSE.md
index 6bec1d6..2258edc 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,4 +1,11 @@
-# MIT License
+# License
+
+The software is licensed under the
+[MIT License](#mit-license).
+Everything else is licensed under the
+[CC BY-SA license](#creative-commons-share-alike-license).
+
+## MIT License
Copyright (c) 2021 Kelly L. Sovacool, Nick Lesniak, and Patrick D. Schloss
@@ -19,3 +26,13 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+
+## Creative Commons Share Alike License
+
+The schtools logo is licensed under the
+[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/#)
+license.
+The hammer and poo images contained in the logo were designed by
+[OpenMoji](https://openmoji.org/), the open-source emoji and icon project,
+and are also licensed under
+[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/#).
diff --git a/NEWS.md b/NEWS.md
index 58430ce..62e1fb3 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -3,7 +3,7 @@
- Refactored `read_tax()` (#30, @kelly-sovacool)
- New function `parse_tax()` to separate that logic of reading and parsing taxonomy files.
- `read_tax()` now accepts a `sep` parameter to handle different delim file types (e.g. csv or tsv).
-
+- schtools now has a logo! (#31, @kelly-sovacool)
# schtools 0.1.0
diff --git a/README.Rmd b/README.Rmd
index 0c50c3d..dacd446 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -15,7 +15,7 @@ knitr::opts_chunk$set(
)
```
-# schtools
+# schtools 
Schloss Lab Tools for Reproducible Microbiome Research π©
@@ -66,9 +66,9 @@ Please note that the schtools project is released with a [Contributor Code of Co
## License
The schtools package is licensed under
-[the MIT license](https://github.com/SchlossLab/schtools/blob/main/LICENSE.md).
-Text and images included in this repository
-are licensed under the [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/).
+[the MIT license](https://github.com/SchlossLab/schtools/blob/main/LICENSE.md#mit-license).
+The logo is licensed under the
+[CC BY-SA license](#creative-commons-share-alike-license)#creative-commons-share-alike-license).
## Citation
diff --git a/README.md b/README.md
index b05be96..4a0f1e9 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-# schtools
+# schtools
Schloss Lab Tools for Reproducible Microbiome Research π©
@@ -59,9 +59,9 @@ By contributing to this project, you agree to abide by its terms.
## License
The schtools package is licensed under [the MIT
-license](https://github.com/SchlossLab/schtools/blob/main/LICENSE.md).
-Text and images included in this repository are licensed under the [CC
-BY 4.0 license](https://creativecommons.org/licenses/by/4.0/).
+license](https://github.com/SchlossLab/schtools/blob/main/LICENSE.md#mit-license).
+The logo is licensed under the [CC BY-SA
+license](#creative-commons-share-alike-license)\#creative-commons-share-alike-license).
## Citation
@@ -70,8 +70,9 @@ BY 4.0 license](https://creativecommons.org/licenses/by/4.0/).
To cite package 'schtools' in publications use:
Kelly Sovacool, Nick Lesniak and Patrick Schloss (2021). schtools:
- Schloss Lab Tools for Reproducible Microbiome Research. R package
- version 0.1.0.9000. https://github.com/SchlossLab/schtools
+ Schloss Lab Tools for Reproducible Microbiome Research.
+ http://www.schlosslab.org/schtools/,
+ https://github.com/SchlossLab/schtools.
A BibTeX entry for LaTeX users is
@@ -79,7 +80,7 @@ A BibTeX entry for LaTeX users is
title = {schtools: Schloss Lab Tools for Reproducible Microbiome Research},
author = {Kelly Sovacool and Nick Lesniak and Patrick Schloss},
year = {2021},
- note = {R package version 0.1.0.9000},
- url = {https://github.com/SchlossLab/schtools},
+ note = {http://www.schlosslab.org/schtools/,
+https://github.com/SchlossLab/schtools},
}
```
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..4bdb7c7
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,14 @@
+url: http://www.schlosslab.org/schtools
+destination: docs
+articles:
+- title: Vignettes
+ navbar: Vignettes
+ contents:
+ - introduction
+authors:
+ Kelly Sovacool:
+ href: "https://github.com/kelly-sovacool"
+ Nick Lesniak:
+ href: "https://github.com/NLesniak"
+ Patrick Schloss:
+ href: "https://github.com/pschloss"
diff --git a/docs/404.html b/docs/404.html
index 9a7bb7a..897b337 100644
--- a/docs/404.html
+++ b/docs/404.html
@@ -6,12 +6,19 @@
Page not found (404) β’ schtools
+
+
+
+
+
+
-
-
+
+
-
-
+
+
+
Contributor Covenant Code of Conduct β’ schtoolsContributor Covenant Code of Conduct β’ schtools
@@ -26,12 +26,14 @@
Reference
-
+
Articles
-