Skip to content

Commit

Permalink
Doc updates (#38)
Browse files Browse the repository at this point in the history
* Use https

* remove comment

* Pkgdown tweak

* CRAN check badge

* NEWS and version bump
  • Loading branch information
grantmcdermott authored Dec 14, 2023
1 parent e36ab94 commit 7f67608
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 9 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: ggfixest
Title: Dedicated 'ggplot2' Methods for 'fixest' Objects
Version: 0.1.0
Version: 0.1.0.9001
Date: 2023-12-12
Authors@R:
c(person(given = "Grant",
Expand All @@ -23,7 +23,7 @@ Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
URL: http://grantmcdermott.com/ggfixest/
URL: https://grantmcdermott.com/ggfixest/
BugReports: https://github.com/grantmcdermott/ggfixest/issues
Depends:
ggplot2 (>= 2.2.0),
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# ggfixest 0.1.0.9001 (development version)

- Minor website and documentation improvements.

# ggfixest 0.1.0

First CRAN release!
Expand Down
2 changes: 1 addition & 1 deletion R/ggcoefplot.R
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@
#' scale_fill_brewer(palette = 'Set1', aesthetics = c("colour", "fill"))
#' # etc.
#'
#'#' @export
#' @export
ggcoefplot = function(
object,
geom_style = c('pointrange', 'errorbar'),
Expand Down
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ knitr::opts_chunk$set(
<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/ggfixest)](https://CRAN.R-project.org/package=ggfixest)
[![R-universe status badge](https://grantmcdermott.r-universe.dev/badges/ggfixest)](https://grantmcdermott.r-universe.dev)
[![CRAN checks](https://badges.cranchecks.info/worst/ggfixest.svg)](https://cran.r-project.org/web/checks/check_results_ggfixest.html)
[![R-CMD-check](https://github.com/grantmcdermott/ggfixest/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/grantmcdermott/ggfixest/actions/workflows/R-CMD-check.yaml)
[![Docs](https://img.shields.io/badge/docs-homepage-blue.svg)](https://grantmcdermott.com/ggfixest/index.html)
<!-- badges: end -->
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
status](https://www.r-pkg.org/badges/version/ggfixest)](https://CRAN.R-project.org/package=ggfixest)
[![R-universe status
badge](https://grantmcdermott.r-universe.dev/badges/ggfixest)](https://grantmcdermott.r-universe.dev)
[![CRAN checks](https://badges.cranchecks.info/worst/ggfixest.svg)](https://cran.r-project.org/web/checks/check_results_ggfixest.html)
[![R-CMD-check](https://github.com/grantmcdermott/ggfixest/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/grantmcdermott/ggfixest/actions/workflows/R-CMD-check.yaml)
[![Docs](https://img.shields.io/badge/docs-homepage-blue.svg)](https://grantmcdermott.com/ggfixest/index.html)
<!-- badges: end -->
Expand Down
31 changes: 26 additions & 5 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,37 @@
url: http://grantmcdermott.com/ggiplot/
url: https://grantmcdermott.com/ggiplot/

home:
title: Dedicated 'ggplot2' Methods for 'fixest' Objects

template:
bootstrap: 5

development:
mode: auto

navbar:
title: ~
type: default
left:
- text: Vignettes
- text: Tutorials
href: articles/index.html
menu:
- text: Comparing ggiplot with iplot
- text: Comparing ggiplot to iplot
href: articles/ggiplot.html
- text: Functions
href: reference/index.html
- text: News
href: news/index.html
- text: Reference
href: reference/index.html

reference:
- subtitle: Plotting
desc: >
The main user-facing functions of the package.
contents:
- ggcoefplot
- subtitle: Utilities
desc: >
Helper functions that are used as inputs to the main plotting functions.
contents:
- aggr_es
- iplot_data
1 change: 0 additions & 1 deletion man/ggcoefplot.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7f67608

Please sign in to comment.