Add {pkgdown} website

.Rbuildignore

@@ -7,3 +7,6 @@
 ^docs$
 ^CRAN-RELEASE$
 ^cran-comments\.md$
+^_pkgdown\.yml$
+^pkgdown$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/pkgdown.yaml

@@ -0,0 +1,48 @@
+# 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: [dev, master]
+  pull_request:
+    branches: [dev, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -1,3 +1,5 @@
 .Rproj.user
 inst/doc
 scratch/*.*
+.Rhistory
+docs

DESCRIPTION

@@ -1,19 +1,18 @@
 Package: Q7
 Title: Types and Features for Object Oriented Programming
 Version: 0.1.0.9000
-Authors@R: 
-   c(person("Siqi", "Zhang", 
-            email = "[email protected]", 
-            role = c("aut", "cre"),
-            comment = c(ORCID = "0000-0003-2617-5776")),
-     person("Bayer HealthCare", 
-            role = c("fnd")))
-Description: 
-    Construct message-passing style objects with types and features. Q7 types uses composition instead of inheritance in creating derived types, allowing definining any code segment as feature and associating any feature to any object. Compared to R6, Q7 is simpler, more flexible, and more friendly.
+Authors@R: c(
+    person("Siqi", "Zhang", , "[email protected]", role = c("aut", "cre"),
+           comment = c(ORCID = "0000-0003-2617-5776")),
+    person("Bayer HealthCare", role = "fnd")
+  )
+Description: Construct message-passing style objects with types and
+    features. Q7 types uses composition instead of inheritance in creating
+    derived types, allowing definining any code segment as feature and
+    associating any feature to any object. Compared to R6, Q7 is simpler,
+    more flexible, and more friendly.
 License: GPL-3
-Encoding: UTF-8
-LazyData: true
-RoxygenNote: 7.1.1
+URL: https://iqis.github.io/Q7/, https://github.com/iqis/Q7
 Depends:
     R (>= 3.6.0)
 Imports:
@@ -22,4 +21,8 @@ Suggests:
     knitr,
     rmarkdown,
     testthat
-VignetteBuilder: knitr
+VignetteBuilder: 
+    knitr
+Encoding: UTF-8
+LazyData: true
+RoxygenNote: 7.2.3

NAMESPACE

@@ -5,6 +5,7 @@ S3method(print,Q7instance)
 S3method(print,Q7type)
 export("%>%")
 export(clone)
+export(expose_private)
 export(extend)
 export(feature)
 export(feature_generic)

README.Rmd

@@ -17,6 +17,7 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 [![Travis build status](https://travis-ci.org/iqis/q7.svg?branch=master)](https://travis-ci.org/iqis/q7)
+[![CRAN status](https://www.r-pkg.org/badges/version/Q7)](https://CRAN.R-project.org/package=Q7)
 <!-- badges: end -->
 
 Q7 is a type system that enables a postmodern flavor of compositional object-oriented programming (OOP). It is simple, flexible and promotes healthy program design. 

README.md

@@ -9,6 +9,8 @@
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 [![Travis build
 status](https://travis-ci.org/iqis/q7.svg?branch=master)](https://travis-ci.org/iqis/q7)
+[![CRAN
+status](https://www.r-pkg.org/badges/version/Q7)](https://CRAN.R-project.org/package=Q7)
 <!-- badges: end -->
 
 Q7 is a type system that enables a postmodern flavor of compositional
@@ -17,12 +19,12 @@ healthy program design.
 
 Q7 features:
 
-  - `type()`, `feature()` and `implement()` to compose objects;
-  - For each object, `initialize()` and `finalize()` to run at its
-    beginning and end of life;
-  - For each object, `public`, `private`, `final`, `private_final` and
-    `active` binding modifiers to change the visibility and behavior of
-    its members.
+- `type()`, `feature()` and `implement()` to compose objects;
+- For each object, `initialize()` and `finalize()` to run at its
+  beginning and end of life;
+- For each object, `public`, `private`, `final`, `private_final` and
+  `active` binding modifiers to change the visibility and behavior of
+  its members.
 
 ## Installation
 
@@ -34,7 +36,6 @@ devtools::install_github("iqis/Q7")
 ``` r
 require(Q7)
 #> Loading required package: Q7
-#> Loading required package: magrittr
 #> 
 #> Attaching package: 'Q7'
 #> The following object is masked from 'package:base':
@@ -62,7 +63,7 @@ Adder <- type(function(num1, num2){
 myAdder <- Adder(1, 2)
 ```
 
-3, Enjoy\!
+3, Enjoy!
 
 ``` r
 myAdder$add_nums()

_pkgdown.yml

@@ -0,0 +1,3 @@
+url: https://iqis.github.io/Q7/
+template:
+  bootstrap: 5