From 00f7524c6fb8cf06b1ad86af0bf9deb085426b39 Mon Sep 17 00:00:00 2001 From: Jerid Francom Date: Sun, 10 Mar 2024 15:38:14 -0400 Subject: [PATCH] adds intro, theme changes, readme updated --- DESCRIPTION | 3 +++ README.Rmd | 3 ++- README.md | 4 +++- _pkgdown.yml | 5 ++++- vignettes/.gitignore | 2 ++ vignettes/qtkit.Rmd | 19 +++++++++++++++++++ 6 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 vignettes/.gitignore create mode 100644 vignettes/qtkit.Rmd diff --git a/DESCRIPTION b/DESCRIPTION index d1fefda..4b2a7e3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -10,9 +10,12 @@ Description: Support package for the textbook "An Introduction to Date: 2024-03-10 License: GPL (>= 3) Suggests: + knitr, + rmarkdown, testthat (>= 3.0.0) Config/testthat/edition: 3 Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.1 URL: https://qtalr.github.io/qtkit/ +VignetteBuilder: knitr diff --git a/README.Rmd b/README.Rmd index 4ebf689..c8b1a37 100644 --- a/README.Rmd +++ b/README.Rmd @@ -13,11 +13,12 @@ knitr::opts_chunk$set( ) ``` -# Quantitative Text Kit (`qtkit`) +# Quantitative Text Kit [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![CRAN status](https://www.r-pkg.org/badges/version/qtkit)](https://CRAN.R-project.org/package=qtkit) +[![Update universe](https://github.com/r-universe/francojc/actions/workflows/sync.yml/badge.svg)](https://github.com/r-universe/francojc/actions/workflows/sync.yml) The goal of `qtkit` is to provide a support package for the textbook ["An Introduction to Quantitative Text Analysis for Linguistics: Reproducible Research using R"](https://qtalr.github.io/book). It contains functions for collecting and manipulating data and datasets, documentation, and other assorted tasks associated with quantative text analysis in R. diff --git a/README.md b/README.md index 558ddfd..fcb7407 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -# Quantitative Text Kit (`qtkit`) +# Quantitative Text Kit @@ -10,6 +10,8 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![CRAN status](https://www.r-pkg.org/badges/version/qtkit.png)](https://CRAN.R-project.org/package=qtkit) +[![Update +universe](https://github.com/r-universe/francojc/actions/workflows/sync.yml/badge.svg)](https://github.com/r-universe/francojc/actions/workflows/sync.yml) The goal of `qtkit` is to provide a support package for the textbook diff --git a/_pkgdown.yml b/_pkgdown.yml index e1086af..2c9ef2e 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,9 +1,12 @@ url: https://qtalr.github.io/qtkit/ template: bootstrap: 5 - bootswatch: materia + bootswatch: flatly + bslib: + pkgdown-nav-height: 75px navbar: + bg: secondary structure: left: - intro diff --git a/vignettes/.gitignore b/vignettes/.gitignore new file mode 100644 index 0000000..097b241 --- /dev/null +++ b/vignettes/.gitignore @@ -0,0 +1,2 @@ +*.html +*.R diff --git a/vignettes/qtkit.Rmd b/vignettes/qtkit.Rmd new file mode 100644 index 0000000..37350ce --- /dev/null +++ b/vignettes/qtkit.Rmd @@ -0,0 +1,19 @@ +--- +title: "qtkit" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{qtkit} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>" +) +``` + +```{r setup} +library(qtkit) +```