https://github.com/alexslemonade/spellcheck
This repository contains a Docker image with the R spelling package
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.9%) to scientific vocabulary
Repository
This repository contains a Docker image with the R spelling package
Basic Info
- Host: GitHub
- Owner: AlexsLemonade
- License: mit
- Language: R
- Default Branch: main
- Size: 68.4 KB
Statistics
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 1
- Releases: 8
Metadata Files
README.md
spellcheck
This repository contains a GitHub action to run the R spelling package.
The role of this action is to facilitate spell checking actions across AlexsLemonade repositories.
Currently the action will only spell check text in Markdown (.md) and Rmarkdown (.Rmd) files.
Usage
To use this action, create a .github/workflows/spellcheck.yml file in your repository with the following contents (modified to fit your exact needs):
```yaml name: Check Spelling on: pull_request: branches: - main
jobs: spell-check: runs-on: ubuntu-latest name: Spell check files steps:
- name: Checkout
uses: actions/checkout@v4
- name: Spell check action
uses: alexslemonade/spellcheck@v0
id: spell
with:
dictionary: components/dictionary.txt
- name: Upload spell check errors
uses: actions/upload-artifact@v4
with:
name: spell_check_errors
path: spell_check_errors.tsv
- name: Fail if there are spelling errors
if: steps.spell.outputs.error_count > 0
run: |
echo "There were ${{ steps.spell.outputs.error_count }} errors"
exit 1
```
Note that the dictionary input to the spell check step is optional and defaults to components/dictionary.txt.
If you want to use a different dictionary, you can specify the path to the dictionary file in your repository.
You can also specify specific files to spell check using the files input to the alexslemonade/spellcheck step.
Note that the file extenstion restriction will still apply.
Globs should work as expected.
Owner
- Name: Alex's Lemonade Stand Foundation
- Login: AlexsLemonade
- Kind: organization
- Website: https://www.alexslemonade.org
- Repositories: 70
- Profile: https://github.com/AlexsLemonade
Childhood Cancer Data Lab of ALSF
GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 3
- Total pull requests: 30
- Average time to close issues: 1 day
- Average time to close pull requests: about 8 hours
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 1.67
- Average comments per pull request: 0.53
- Merged pull requests: 26
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- sjspielman (3)
Pull Request Authors
- jashapiro (21)
- sjspielman (9)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- docker/build-push-action v5 composite
- docker/login-action v3 composite
- docker/metadata-action v5 composite
- docker/setup-buildx-action v3 composite
- ./ * composite
- actions/checkout v4 composite
- docker://ghcr.io/alexslemonade/spellcheck v0.1.1 docker
- rocker/r-ver 4.3.2 build