Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ramiromagno committed Jun 29, 2024
0 parents commit 33df5ce
Show file tree
Hide file tree
Showing 30 changed files with 6,648 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
^.*\.Rproj$
^\.Rproj\.user$
^LICENSE\.md$
^_pkgdown\.yml$
^docs$
^pkgdown$
^vignettes/articles$
^README\.Rmd$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
52 changes: 52 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -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")'
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata
docs
vignettes
16 changes: 16 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Package: chic
Title: pkgdown Template for Pattern Institute Packages
Version: 0.0.1
Authors@R: c(
person("Ramiro", "Magno", , "[email protected]", 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
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: Pattern Institute
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Generated by roxygen2: do not edit by hand

export(pi)
8 changes: 8 additions & 0 deletions R/pi.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#' Not so obvious \eqn{\pi}
#'
#' As the title says.
#'
#' @export
pi <- function() {
pi
}
47 changes: 47 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
output: github_document
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```


# chic <img src="man/figures/logo.svg" align="right" height=140/>

<!-- badges: start -->
[![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)
<!-- badges: end -->

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
```
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

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

# chic <img src="man/figures/logo.svg" align="right" height=140/>

<!-- badges: start -->

[![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)
<!-- badges: end -->

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
```
5 changes: 5 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
url: https://www.pattern.institute/chic/

template:
package: chic
bootstrap: 5
21 changes: 21 additions & 0 deletions chic.Rproj
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions inst/pkgdown/BS5/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.bak
25 changes: 25 additions & 0 deletions inst/pkgdown/BS5/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -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: ""
Loading

0 comments on commit 33df5ce

Please sign in to comment.