Skip to content

Commit

Permalink
update readme and website
Browse files Browse the repository at this point in the history
  • Loading branch information
mianzg committed Jul 17, 2024
1 parent 3856729 commit 706e892
Show file tree
Hide file tree
Showing 11 changed files with 87 additions and 1,159 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
^_pkgdown\.yml$
^docs$
^pkgdown$
^\.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")'
13 changes: 9 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ knitr::opts_chunk$set(

[![License: CC BY
4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)

[![R-CMD-check](https://github.com/openwashdata/saniabidjan/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/saniabidjan/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of saniabidjan is to provide survey data about the behavior and practices of managing sanitation facilties in two low-income areas of Abidjan, Cote d’Ivoire.
Expand Down Expand Up @@ -83,8 +83,7 @@ library(saniabidjan)

### saniabidjan

The dataset `saniabidjan` contains data about household surveys that cover 101 households in Abobo and 106 households in Yopougon.
It has `r nrow(saniabidjan)` observations and `r ncol(saniabidjan)` variables
The dataset `saniabidjan` contains data about household surveys that cover 101 households in Abobo and 106 households in Yopougon. It has `r nrow(saniabidjan)` observations and `r ncol(saniabidjan)` variables

```{r}
saniabidjan |>
Expand All @@ -109,8 +108,14 @@ readr::read_csv("data-raw/dictionary.csv") |>

```{r}
library(saniabidjan)
library(ggplot2)
# Provide some example code here
saniabidjan |>
ggplot(mapping = aes(x = facilities_type)) +
geom_bar(aes(fill = lat_care), position = "dodge") +
labs(title = "Distribution of latrine care for different latrine types",
x = "Type of facilities",
fill = "Latrine care type")
```

## Capstone Project
Expand Down
1,146 changes: 0 additions & 1,146 deletions README.html

This file was deleted.

14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

[![License: CC BY
4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)

[![R-CMD-check](https://github.com/openwashdata/saniabidjan/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/saniabidjan/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of saniabidjan is to provide survey data about the behavior and
Expand Down Expand Up @@ -67,7 +67,7 @@ saniabidjan |>
gt::as_raw_html()
```

<div id="wjfrmxviey" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
<div id="jnnhpxvdax" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
&#10; <table class="gt_table" data-quarto-disable-processing="false" data-quarto-bootstrap="false" style="-webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; font-family: system-ui, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji'; display: table; border-collapse: collapse; line-height: normal; margin-left: auto; margin-right: auto; color: #333333; font-size: 16px; font-weight: normal; font-style: normal; background-color: #FFFFFF; width: auto; border-top-style: solid; border-top-width: 2px; border-top-color: #A8A8A8; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #A8A8A8; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3;" bgcolor="#FFFFFF">
<thead style="border-style: none;">
<tr class="gt_col_headings" style="border-style: none; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3;">
Expand Down Expand Up @@ -500,10 +500,18 @@ and (4) typhoid fever.

``` r
library(saniabidjan)

library(ggplot2)
# Provide some example code here
saniabidjan |>
ggplot(mapping = aes(x = facilities_type)) +
geom_bar(aes(fill = lat_care), position = "dodge") +
labs(title = "Distribution of latrine care for different latrine types",
x = "Type of facilities",
fill = "Latrine care type")
```

<img src="man/figures/README-unnamed-chunk-7-1.png" width="100%" style="display: block; margin: auto;" />

## Capstone Project

This dataset is shared as part of a capstone project in Data Science for
Expand Down
15 changes: 11 additions & 4 deletions docs/index.html

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

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ pandoc: 3.1.11
pkgdown: 2.1.0
pkgdown_sha: ~
articles: {}
last_built: 2024-07-17T11:06Z
last_built: 2024-07-17T14:32Z
urls:
reference: https://github.com/openwashdata/saniabidjan/reference
article: https://github.com/openwashdata/saniabidjan/articles
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 706e892

Please sign in to comment.