Skip to content

Commit

Permalink
Revision of the vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
phgrosjean committed Apr 30, 2024
1 parent 3d8e589 commit 3db2382
Show file tree
Hide file tree
Showing 16 changed files with 238 additions and 275 deletions.
36 changes: 15 additions & 21 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,25 +1,19 @@
.DS_Store
.gitignore
.git
.git/*
README.md
FAQ.md
TODO.md
CODE_OF_CONDUCT.md
LICENSE.md
Makefile
.Rprofile
^\.DS_Store$
^\.Rproj\.user$
^\.*\Rproj$
^\.travis\.yml$
^appveyor\.yml$
^codecov\.yml$
^.*\.Rproj$
^doc$
^Meta$
^_pkgdown\.yml$
^docs$
^pkgdown$
^.+\.Rproj$
^\.gitignore$
^\.git$
^\.github$
^Makefile$
^\.Rprofile$
^revdep$
^codecov\.yml$
^CODE_OF_CONDUCT\.md$
^FAQ\.md$
^LICENSE\.md$
^README\.Rmd$
^README\.Rmd$
^TODO\.md$
^_pkgdown\.yml$
^pkgdown$
^docs$
3 changes: 2 additions & 1 deletion .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

Expand All @@ -47,3 +47,4 @@ jobs:
- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'
6 changes: 4 additions & 2 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ jobs:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

Expand All @@ -43,7 +45,7 @@ jobs:

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@4.1.4
uses: JamesIves/github-pages-deploy-action@4.5.0
with:
clean: false
branch: gh-pages
Expand Down
53 changes: 53 additions & 0 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]

name: test-coverage

jobs:
test-coverage:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::covr
needs: coverage

- name: Test coverage
run: |
token <- Sys.getenv("CODECOV_TOKEN", "")
covr::codecov(
quiet = FALSE,
clean = FALSE,
install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package"),
token = if (token != "") token
)
shell: Rscript {0}

- name: Show testthat output
if: always()
run: |
## --------------------------------------------------------------------
find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true
shell: bash

- name: Upload test results
if: failure()
uses: actions/upload-artifact@v4
with:
name: coverage-test-failures
path: ${{ runner.temp }}/package
17 changes: 13 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

# Session Data files
.RData
.RDataTmp

# User-specific files
.Ruserdata
Expand Down Expand Up @@ -38,11 +39,19 @@ vignettes/*.pdf
# R Environment Variables
.Renviron

# Locally generated pkgdown site
docs
# pkgdown site
docs/

# translation temp files
po/*~

# RStudio Connect folder
rsconnect/
.Rproj.user

# Mac files
.DS_Store
doc
Meta

# More files
inst/doc
docs
50 changes: 24 additions & 26 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
Expand All @@ -21,25 +21,25 @@ community include:
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards
of acceptable behavior and will take appropriate and fair corrective action in
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Expand All @@ -50,17 +50,17 @@ decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies
when an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail
address, posting via an official social media account, or acting as an appointed
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at [INSERT CONTACT
METHOD]. All complaints will be reviewed and investigated promptly and fairly.
reported to the community leaders responsible for enforcement at phgrosjean@sciviews.org.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Expand Down Expand Up @@ -114,15 +114,13 @@ community.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0,
available at https://www.contributor-covenant.org/version/2/0/
code_of_conduct.html.
version 2.1, available at
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://
www.contributor-covenant.org/translations.
<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

[homepage]: https://www.contributor-covenant.org
25 changes: 15 additions & 10 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
Package: modelit
Type: Package
Version: 1.4.3
Title: 'SciViews' - Statistical Models Within 'SciViews::R'
Description: Create and Use Statistical Models (Linear, General, Nonlinear, ...)
by using a SciViews::R common formula interface and label-aware functions.
Version: 1.4.4
Title: Statistical Models for 'SciViews::R'
Description: Create and use statistical models (linear, general, nonlinear...)
with extensions to support rich-formatted tables, equations and plots for the
'SciViews::R' dialect.
Authors@R: c(
person("Philippe", "Grosjean", role = c("aut", "cre"),
email = "phgrosjean@sciviews.org",
comment = c(ORCID = "0000-0002-2694-9471")))
email = "phgrosjean@sciviews.org",
comment = c(ORCID = "0000-0002-2694-9471")),
person("Guyliann", "Engels", role = c("aut"),
email = "guyliann.engels@umons.ac.be",
comment = c(ORCID = "0000-0001-9514-1014")))
Maintainer: Philippe Grosjean <phgrosjean@sciviews.org>
Depends:
R (>= 4.0.0),
R (>= 4.2.0),
broom
Imports:
chart,
Expand All @@ -28,16 +32,17 @@ Imports:
Suggests:
datasets,
parsnip,
covr,
dplyr,
rmarkdown,
spelling,
testthat (>= 3.0.0)
Remotes:
SciViews/chart,
SciViews/svFlow,
SciViews/tabularise,
SciViews/data.io
License: GPL (>= 2)
SciViews/data.io,
ardata-fr/equatags
License: MIT + file LICENSE
URL: https://github.com/SciViews/modelit, https://www.sciviews.org/modelit/
BugReports: https://github.com/SciViews/modelit/issues
Roxygen: list(markdown = TRUE)
Expand Down
2 changes: 2 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
YEAR: 2024
COPYRIGHT HOLDER: Philippe Grosjean
Loading

0 comments on commit 3db2382

Please sign in to comment.