Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create schtools logo #31

Merged
merged 15 commits into from
Mar 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
^codecov\.yml$
^cran-comments\.md$
^CRAN-RELEASE$
^vignettes/articles$
^_pkgdown\.yml$
28 changes: 28 additions & 0 deletions .github/workflows/on-release.yml
Original file line number Diff line number Diff line change
@@ -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 "[email protected]"
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
4 changes: 4 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,13 @@ Imports:
tidyr
Suggests:
covr,
cowplot,
here,
hexSticker,
knitr,
purrr,
rmarkdown,
showtext,
testthat
VignetteBuilder:
knitr
Expand Down
19 changes: 18 additions & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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/#).
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ knitr::opts_chunk$set(
)
```

# schtools
# schtools <a href='http://www.schlosslab.org/schtools'><img src='man/figures/logo.png' align="right" height="139" /></a>

Schloss Lab Tools for Reproducible Microbiome Research 💩

Expand Down Expand Up @@ -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

Expand Down
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

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

# schtools
# schtools <a href='http://www.schlosslab.org/schtools'><img src='man/figures/logo.png' align="right" height="139" /></a>

Schloss Lab Tools for Reproducible Microbiome Research 💩

Expand Down Expand Up @@ -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

Expand All @@ -70,16 +70,17 @@ 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

@Manual{,
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},
}
```
14 changes: 14 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -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"
32 changes: 21 additions & 11 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 6 additions & 4 deletions docs/CODE_OF_CONDUCT.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading