diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 0000000..2eb6fcc --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,9 @@ +^.*\.Rproj$ +^\.Rproj\.user$ +^LICENSE\.md$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ +^vignettes/articles$ +^README\.Rmd$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 0000000..0f2fe08 --- /dev/null +++ b/.github/workflows/R-CMD-check.yaml @@ -0,0 +1,52 @@ +# 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: R-CMD-check + +permissions: read-all + +jobs: + R-CMD-check: + runs-on: ${{ matrix.config.os }} + + name: ${{ matrix.config.os }} (${{ matrix.config.r }}) + + strategy: + fail-fast: false + matrix: + config: + - {os: macos-latest, r: 'release'} + - {os: windows-latest, r: 'release'} + - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} + - {os: ubuntu-latest, r: 'release'} + - {os: ubuntu-latest, r: 'oldrel-1'} + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.config.r }} + http-user-agent: ${{ matrix.config.http-user-agent }} + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::rcmdcheck + needs: check + + - uses: r-lib/actions/check-r-package@v2 + with: + upload-snapshots: true + build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c3b9bf9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.Rproj.user +.Rhistory +.RData +.Ruserdata +docs +vignettes diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..e5b0b7d --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,16 @@ +Package: chic +Title: pkgdown Template for Pattern Institute Packages +Version: 0.0.1 +Authors@R: c( + person("Ramiro", "Magno", , "rmagno@pattern.institute", role = c("aut", "cre"), + comment = c(ORCID = "0000-0001-5226-3441")), + person("Pattern Institute", role = c("cph", "fnd")) + ) +Description: A pkgdown template for use by Pattern Institute R packages. +License: MIT + file LICENSE +Encoding: UTF-8 +Roxygen: list(markdown = TRUE) +RoxygenNote: 7.3.1 +Config/Needs/website: rmarkdown +URL: https://www.github.com/patterninstitute/chic/ +BugReports: https://www.github.com/patterninstitute/chic/issues diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..526b4d2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,2 @@ +YEAR: 2024 +COPYRIGHT HOLDER: Pattern Institute diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..d9a2d1d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2024 Pattern Institute + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +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. diff --git a/NAMESPACE b/NAMESPACE new file mode 100644 index 0000000..c689035 --- /dev/null +++ b/NAMESPACE @@ -0,0 +1,3 @@ +# Generated by roxygen2: do not edit by hand + +export(pi) diff --git a/R/pi.R b/R/pi.R new file mode 100644 index 0000000..1daee81 --- /dev/null +++ b/R/pi.R @@ -0,0 +1,8 @@ +#' Not so obvious \eqn{\pi} +#' +#' As the title says. +#' +#' @export +pi <- function() { + pi +} diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000..537f7e0 --- /dev/null +++ b/README.Rmd @@ -0,0 +1,47 @@ +--- +output: github_document +--- + + + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>", + fig.path = "man/figures/README-", + out.width = "100%" +) +``` + + +# chic + + +[![CRAN status](https://www.r-pkg.org/badges/version/chic)](https://CRAN.R-project.org/package=chic) +[![R-CMD-check](https://github.com/patterninstitute/chic/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/patterninstitute/chic/actions/workflows/R-CMD-check.yaml) + + +A pkgdown template for Pattern Institute R packages. + +## Installation + +``` r +# install.packages("devtools") +devtools::install_github("patterninstitute/chic") +``` + +## Usage + +Add to `DESCRIPTION`: + +``` +Config/Needs/website: patterninstitute/chic +``` + +And in `_pkgdown.yml`: + +```yml +template: + package: chic + bootstrap: 5 +``` diff --git a/README.md b/README.md new file mode 100644 index 0000000..5517f34 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ + + + +# chic + + + +[![CRAN +status](https://www.r-pkg.org/badges/version/chic)](https://CRAN.R-project.org/package=chic) +[![R-CMD-check](https://github.com/patterninstitute/chic/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/patterninstitute/chic/actions/workflows/R-CMD-check.yaml) + + +A pkgdown template for Pattern Institute R packages. + +## Installation + +``` r +# install.packages("devtools") +devtools::install_github("patterninstitute/chic") +``` + +## Usage + +Add to `DESCRIPTION`: + + Config/Needs/website: patterninstitute/chic + +And in `_pkgdown.yml`: + +``` yml +template: + package: chic + bootstrap: 5 +``` diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..a48c2b9 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,5 @@ +url: https://www.pattern.institute/chic/ + +template: + package: chic + bootstrap: 5 diff --git a/chic.Rproj b/chic.Rproj new file mode 100644 index 0000000..ce013e1 --- /dev/null +++ b/chic.Rproj @@ -0,0 +1,21 @@ +Version: 1.0 + +RestoreWorkspace: Default +SaveWorkspace: Default +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 2 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: XeLaTeX + +AutoAppendNewline: Yes +StripTrailingWhitespace: Yes + +BuildType: Package +PackageUseDevtools: Yes +PackageInstallArgs: --no-multiarch --with-keep.source +PackageRoxygenize: rd,collate,namespace diff --git a/inst/pkgdown/BS5/.gitignore b/inst/pkgdown/BS5/.gitignore new file mode 100644 index 0000000..751553b --- /dev/null +++ b/inst/pkgdown/BS5/.gitignore @@ -0,0 +1 @@ +*.bak diff --git a/inst/pkgdown/BS5/_pkgdown.yml b/inst/pkgdown/BS5/_pkgdown.yml new file mode 100644 index 0000000..1ae6a46 --- /dev/null +++ b/inst/pkgdown/BS5/_pkgdown.yml @@ -0,0 +1,25 @@ +template: + bslib: + primary: "#2a6773" + base_font: + google: + family: "Nunito" + wght: [200, 300, 400, 600, 700, 800] + ital: [0, 1] + code_font: {google: "Inconsolata"} + heading_font: {google: "Source Sans Pro"} + font_scale: 1.0 + fg: "#172431" + bg: "#fcfcfc" + pkgdown-nav-height: 76px + +navbar: + type: light + bg: none + +footer: + structure: + left: developed_by + right: pkgdown + components: + pkgdown: "" diff --git a/inst/pkgdown/BS5/extra.scss b/inst/pkgdown/BS5/extra.scss new file mode 100644 index 0000000..eab5ede --- /dev/null +++ b/inst/pkgdown/BS5/extra.scss @@ -0,0 +1,156 @@ +$faint-background: #f9f9f9 !default; +$faint-border: #efefef !default; +$navbar-background: $faint-background !default; +$footer-background: $faint-background !default; + +$heading-margins: ( + "h2 h3": 1.5rem, + "h3 h4": 1.25rem, + "h4 h5": 1.125rem, + "h5 h6": 1rem +); + +h2, h3, h4, h5, h6 { + margin-bottom: 1rem; +} + +h2 { + @include font-size(1.8rem); + margin-top: 1.75rem; +} + +main .page-header + .section h2 { + margin-top: 1rem; +} + +h3 { + @include font-size(1.5rem); + margin-top: 1.5rem; +} + +h4 { + @include font-size(1.2rem); + font-weight: bold; + margin-top: 1.25rem; +} + +h1 { + & + h2, & + h3, & + h4, & + h5, & + h6 { + margin-top: 1.75rem; + } +} + +@each $pair, $margin in $heading-margins { + #{$pair} { + margin-top: $margin; + } +} + +.page-header { + border-bottom: 1px solid $faint-border; + margin-bottom: 1rem; + h1 { margin-top: 3rem; } +} + +nav.navbar { + border-bottom: 1px solid $faint-border; + background-color: $navbar-background; + padding: 1rem 0; + font-size: 1.2rem; +} + +.navbar-light .navbar-nav .active > .nav-link { + background: transparent; + font-weight: 600; + color: #444; +} + +.navbar-light .navbar-nav .nav-item > .nav-link:hover { + background: transparent; + text-decoration: underline; +} + +.dropdown-menu { + box-shadow: 0 2px 5px 0 rgba(120, 120, 120, 0.1); +} + +.dropdown-item { + &:hover, &:focus { + background: $body-bg; + text-decoration: underline; + } +} + +@include media-breakpoint-up(sm) { + #toc { top: calc(#{$pkgdown-nav-height} + 2rem); } +} + +.row > aside { + margin-top: calc(2rem + #{$pkgdown-nav-height}); +} + +aside { + line-height: 1.3; + h2 { + font-family: 'Source Sans Pro'; + font-size: 1.1rem; + text-transform: uppercase; + margin: 2rem 0 0.75rem 0; + font-weight: bold; + letter-spacing: 0.05rem; + color: $gray-700; + } + + div:first-child h2, + nav:first-child h2 { + margin-top: 0; + } + + .list-unstyled li { margin-bottom: 0.5rem; } +} + +#toc .nav a.nav-link { + color: inherit; + padding: 0.25rem 0; + &:hover, &:focus, &.active { + text-decoration: underline; + color: $primary; + background-color: $body-bg; + } + &.active { font-weight: 600; } +} + +footer { + margin-top: 2rem; + border-top: 3px solid $faint-border; + padding: 1rem 0; +} + +pre, code { + border: none; + background-image: linear-gradient(-160deg, #f8f8f8 0, #f1f1f1 100%); +} + +pre code { background: transparent; } + +pre { font-size: 0.9em; } + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background: transparent; + padding: 0; +} + +code { border-radius: 2px; } + +ol, ul { padding-left: 2rem; } + +main { + li { + margin-bottom: 0.1rem; + li { margin-bottom: 0; } + } + + ul ul, ol ol, ul ol, ol ul { + margin: 0.3rem 0; + } +} diff --git a/inst/pkgdown/BS5/extra.scss.bak2 b/inst/pkgdown/BS5/extra.scss.bak2 new file mode 100644 index 0000000..6e849b7 --- /dev/null +++ b/inst/pkgdown/BS5/extra.scss.bak2 @@ -0,0 +1,178 @@ +$faint-background: #f9f9f9 !default; +$faint-border: #efefef !default; + +$navbar-background: $faint-background !default; +$footer-background: $faint-background !default; + +$heading-margins: ( + "h2 h3": 1.5rem, + "h3 h4": 1.25rem, + "h4 h5": 1.125rem, + "h5 h6": 1rem, +); + +h2, h3, h4, h5, h6 { + margin-bottom: 1rem; +} + +h2 { + @include font-size(1.8rem); + margin-top: 1.75rem; +} + +main .page-header + .section h2 { + margin-top: 1rem; +} + +h3 { + @include font-size(1.5rem); + margin-top: 1.5rem; +} + +h4 { + @include font-size(1.2rem); + font-weight: bold; + margin-top: 1.25rem; +} + +h1 { + & + h2, & + h3, & + h4, & + h5, & + h6 { + margin-top: 1.75rem; + } +} + +@each $pair, $margin in $heading-margins { + #{$pair} { + margin-top: $margin; + } +} + +.page-header { + border-bottom: 1px solid $faint-border; + margin-bottom: 1rem; + h1 { + margin-top: 3rem; + } +} + +nav.navbar { + border-bottom: 1px solid $faint-border; + background-color: $navbar-background; + padding: 1rem 0; + font-size: 1.2rem; +} + +.navbar-light .navbar-nav .active > .nav-link { + background: transparent; + font-weight: 600; + color: #444; +} + +.navbar-light .navbar-nav .nav-item > .nav-link:hover { + background: transparent; + text-decoration: underline; +} + +.dropdown-menu { + box-shadow: 0 2px 5px 0 rgba(120, 120, 120, 0.1); +} + +.dropdown-item { + &:hover, &:focus { + background: $body-bg; + text-decoration: underline; + } +} + +@include media-breakpoint-up(sm) { + #toc { + top: calc(#{$pkgdown-nav-height} + 2rem); + } +} + +.row > aside { + margin-top: calc(2rem + #{$pkgdown-nav-height}); +} + +aside { + line-height: 1.3; + h2 { + font-family: 'Source Sans Pro'; + font-size: 1.1rem; + text-transform: uppercase; + margin-bottom: 0.75rem; + margin-top: 2rem; + font-weight: bold; + letter-spacing: 0.05rem; + color: $gray-700; + } + + div:first-child h2, + nav:first-child h2 { + margin-top: 0; + } + + .list-unstyled li { + margin-bottom: 0.5rem; + } +} + +#toc .nav { + a.nav-link { + color: inherit; + padding: 0.25rem 0; + &:hover, &:focus, &.active { + text-decoration: underline; + color: $primary; + background-color: $body-bg; + } + &.active { + font-weight: 600; + } + } +} + +footer { + margin-top: 2rem; + border-top: 3px solid $faint-border; + padding: 1rem 0; +} + +pre, code { + border: none; + background-image: linear-gradient(-160deg, #f8f8f8 0, #f1f1f1 100%); +} + +pre code { + background: transparent; +} + +pre { + font-size: 0.9em; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background: transparent; + padding: 0; +} + +code { + border-radius: 2px; +} + +ol, ul { + padding-left: 2rem; +} + +main { + li { + margin-bottom: 0.1rem; + li { + margin-bottom: 0; + } + } + + ul ul, ol ol, ul ol, ol ul { + margin: 0.3rem 0; + } +} diff --git a/inst/pkgdown/BS5/pi.svg b/inst/pkgdown/BS5/pi.svg new file mode 100644 index 0000000..4c66ea3 --- /dev/null +++ b/inst/pkgdown/BS5/pi.svg @@ -0,0 +1,52 @@ + + + + + + + + + + + diff --git a/man/figures/README-pressure-1.png b/man/figures/README-pressure-1.png new file mode 100644 index 0000000..e208311 Binary files /dev/null and b/man/figures/README-pressure-1.png differ diff --git a/man/figures/logo.svg b/man/figures/logo.svg new file mode 100644 index 0000000..463673c --- /dev/null +++ b/man/figures/logo.svg @@ -0,0 +1,6000 @@ + + + + diff --git a/man/pi.Rd b/man/pi.Rd new file mode 100644 index 0000000..2e86f7f --- /dev/null +++ b/man/pi.Rd @@ -0,0 +1,11 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/pi.R +\name{pi} +\alias{pi} +\title{Not so obvious \eqn{\pi}} +\usage{ +pi() +} +\description{ +As the title says. +} diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png new file mode 100644 index 0000000..14e9050 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png new file mode 100644 index 0000000..559e767 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png new file mode 100644 index 0000000..d281758 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png new file mode 100644 index 0000000..edb5615 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png new file mode 100644 index 0000000..8908605 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png new file mode 100644 index 0000000..9977dcf Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png new file mode 100644 index 0000000..bf09155 Binary files /dev/null and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png new file mode 100644 index 0000000..a07352a Binary files /dev/null and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico new file mode 100644 index 0000000..36e53cd Binary files /dev/null and b/pkgdown/favicon/favicon.ico differ