Skip to content

Commit

Permalink
update badge and citation
Browse files Browse the repository at this point in the history
  • Loading branch information
Mian committed May 13, 2024
1 parent 614fae4 commit 837479e
Show file tree
Hide file tree
Showing 7 changed files with 105 additions and 19 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,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")'
40 changes: 23 additions & 17 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.5.0
# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
# --------------------------------------------

cff-version: 1.2.0
message: 'To cite package "washopenresearch" in publications use:'
Expand All @@ -10,6 +10,7 @@ license: CC-BY-4.0
title: 'washopenresearch: Dataset about open research data information in Water, Sanitation,
and Hygiene'
version: 0.0.1
doi: 10.5281/zenodo.11185699
abstract: The goal of washopenresearch is to provide an overview of open research
data related to Water Sanitation and Hygiene (WASH). The package provides access
to two datasets `washdev` and `uncnewsletter`. Each dataset collects information
Expand All @@ -21,22 +22,27 @@ authors:
given-names: Mian
email: mzhong@ethz.ch
orcid: https://orcid.org/0009-0009-4546-7214
date-released: '2024-02-28'
- family-names: Luz
given-names: Ludwig
email: lluz@ethz.ch
orcid: https://orcid.org/0009-0007-9248-3204
- family-names: Schöbitz
given-names: Lars
email: lschoebitz@ethz.ch
orcid: https://orcid.org/0000-0003-2196-5015
repository-code: https://github.com/openwashdata/washopenresearch
url: https://github.com/openwashdata/washopenresearch
date-released: '2024-05-13'
contact:
- family-names: Zhong
given-names: Mian
email: mzhong@ethz.ch
orcid: https://orcid.org/0009-0009-4546-7214
references:
- type: software
title: 'R: A Language and Environment for Statistical Computing'
notes: Depends
url: https://www.R-project.org/
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2024'
institution:
name: R Foundation for Statistical Computing
version: '>= 2.10'
keywords:
- open-data
- open-research-data
- open-science
- openwashdata
- sanitation
- wash

2 changes: 2 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ library(wordcloud2)

[![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/washopenresearch/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/washopenresearch/actions/workflows/R-CMD-check.yaml)
[![DOI](https://zenodo.org/badge/734215029.svg)](https://zenodo.org/doi/10.5281/zenodo.11185699)

<!-- badges: end -->

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

[![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/washopenresearch/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/washopenresearch/actions/workflows/R-CMD-check.yaml)
[![DOI](https://zenodo.org/badge/734215029.svg)](https://zenodo.org/doi/10.5281/zenodo.11185699)

<!-- badges: end -->

Expand Down Expand Up @@ -66,7 +68,7 @@ washdev |>
gt::as_raw_html()
```

<div id="xyknaiygtu" 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="gjxeqgcevp" 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 @@ -544,7 +546,7 @@ uncnewsletter |>
gt::as_raw_html()
```

<div id="mmtuzkdmqj" 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="nssudutzbp" 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
22 changes: 22 additions & 0 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

bibentry(bibtype = "Misc",
key = "zhong_etall:2024",
title = "washopenresearch: Dataset about open research data information in Water, Sanitation, and Hygiene",
author = c(person(given = "Mian",
family = "Zhong",
email = "mzhong@ethz.ch",
comment = c(ORCID = "0009-0009-4546-7214")),
person(given = "Ludwig",
family = "Luz",
email = "lluz@ethz.ch",
comment = c(ORCID = "0009-0007-9248-3204")),
person(given = "Lars",
family = "Schöbitz",
email = "lschoebitz@ethz.ch",
comment = c(ORCID = "0000-0003-2196-5015"))),
year = "2024",
doi = "10.5281/zenodo.11185699",
url = "https://github.com/openwashdata/washopenresearch",
abstract = "The goal of washopenresearch is to provide an overview of open research data related to Water Sanitation and Hygiene (WASH). The package provides access to two datasets `washdev` and `uncnewsletter`. Each dataset collects information on scientific articles about (1) article metadata (e.g. title, first author, correspondence author), (2) supplementary material information, (3) data availability statement, and (4) semantic information (e.g. keywords).",
keywords = "open-data,open-research-data,open-science,openwashdata,sanitation,wash",
version = "0.0.1")

0 comments on commit 837479e

Please sign in to comment.