Skip to content

Commit

Permalink
Modify naming
Browse files Browse the repository at this point in the history
  • Loading branch information
rich-iannone committed Jul 24, 2023
1 parent 1dbf318 commit 19cb01e
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 59 deletions.
7 changes: 4 additions & 3 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ or acting as an appointed representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may
be reported to the community leaders responsible for enforcement at
[riannone@me.com](mailto:riannone@me.com). All complaints will be reviewed and investigated promptly and fairly.
[rich@posit.co](mailto:rich@posit.co). All complaints will be reviewed and
investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security
of the reporter of any incident.
Expand Down Expand Up @@ -119,8 +120,8 @@ within the community.
## Attribution

This Code of Conduct is adapted from the
[Contributor Covenant][homepage], version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
[Contributor Covenant][homepage], version 2.1, available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ assignees: rich-iannone

## Prework

* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
* [ ] If there is [already a relevant issue](https://github.com/rstudio/pointblank/issues), whether open or closed, comment on the existing thread instead of posting a new issue.

## Description
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ assignees: rich-iannone

## Prework

- [ ] Read and abide by **pointblank**'s [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
- [ ] Read and abide by **pointblank**'s [code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
- [ ] Search for duplicates among the [existing issues](https://github.com/rstudio/pointblank/issues) (both open and closed).

## Proposal
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ assignees: ''

## Prework

* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
* [ ] If there is [already a relevant issue](https://github.com/rstudio/pointblank/issues), whether open or closed, comment on the existing thread instead of posting a new issue.

## Question
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Thank you for contributing to **pointblank**! To make this process easier for ev

# Checklist

- [ ] I understand and agree to the [Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
- [ ] I understand and agree to the [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
- [ ] I have listed any major changes in the [NEWS](https://github.com/rstudio/pointblank/blob/main/NEWS.md).
- [ ] I have added [`testthat`](https://github.com/r-lib/testthat) unit tests to [`tests/testthat`](https://github.com/rstudio/pointblank/tree/main/tests/testthat) for any new functionality.
48 changes: 6 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ assembly](https://img.shields.io/static/v1?label=Table%20Scan&message=Ensembl:%2
## OVERVIEW OF PACKAGE FUNCTIONS

There are many functions available in **pointblank** for understanding data
quality and doing data documentation. Here is an overview of all of them,
quality and creating data documentation. Here is an overview of all of them,
grouped by family. For much more information on these, visit the
[documentation website](https://rstudio.github.io/pointblank/) or take
a *Test Drive* in the [Posit Cloud project](https://rstudio.cloud/project/3411822).
Expand Down Expand Up @@ -367,57 +367,21 @@ If you encounter a bug, have usage questions, or want to share ideas to
make this package better, feel free to file an
[issue](https://github.com/rstudio/pointblank/issues).

<hr>

## How **pointblank** Fits in with Other Packages that Validate Tabular Data

The **pointblank** package isn’t the only one of its kind available for
**R**. The reason for introducing yet another has to do with
**pointblank**’s goals:

- making it possible to work with local tables, database tables, and Spark
DataFrames (via **sparklyr**) with the same API
- providing great flexibility in data validation workflows, allowing for:
(1) report-based validations, (2) inline validations, (3) validation of
data tables in unit tests (with the set of `expect_*()` functions),
and (4) validation of data tables to support conditional expressions
(with the set of `test_*()` functions)
- enabling a workflow for collecting and reporting on useful
information about your data tables (i.e., making data dictionaries)
- giving you a tool for understanding new datasets: `scan_data()`
- having the option to translate reporting outputs to multiple
spoken languages
- developing an API that closely follows tidyverse conventions by
adhering to the [tidyverse style guide](https://style.tidyverse.org)
- ensuring that the package is very well-tested so that you can
trust the validations (there are over 6,000 unit tests so far)
- putting lots of attention on making the package documentation and examples
the best they can be

While **pointblank** is trying to do something a little different, it may not
suit your specific needs. That's totally fine, here's a listing of some other
great **R** packages for data validation:

**assertr** ([GITHUB](https://github.com/ropensci/assertr/)[WEBSITE](https://docs.ropensci.org/assertr/))

**validate** ([GITHUB](https://github.com/data-cleaning/validate))

**dataReporter** ([GITHUB](https://github.com/ekstroem/dataReporter))

<hr>
-----

## Code of Conduct

Please note that the pointblank project is released with a [contributor
code of
conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).<br>By
Please note that the gt project is released with a [contributor code of
conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).<br>By
participating in this project you agree to abide by its terms.

## 📄 License

**pointblank** is licensed under the MIT license.
See the [`LICENSE.md`](LICENSE.md) file for more details.

© Posit Software, PBC.

## 🏛️ Governance

This project is primarily maintained by [Rich Iannone](https://twitter.com/riannone). Other authors may occasionally assist with some of these duties.
Expand Down
22 changes: 12 additions & 10 deletions inst/translations/ES/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

<!-- badges: start -->
<a href="https://cran.r-project.org/package=pointblank"><img src="https://www.r-pkg.org/badges/version/pointblank" alt="CRAN status" /></a>
<a href="https://github.com/rich-iannone/pointblank/actions"><img src="https://github.com/rich-iannone/pointblank/workflows/R-CMD-check/badge.svg" alt="R build status" /></a>
<a href="https://github.com/rich-iannone/pointblank/actions"><img src="https://github.com/rich-iannone/pointblank/workflows/pkgdown/badge.svg" alt="Package Site" /></a>
<a href="https://github.com/rich-iannone/pointblank/actions"><img src="https://github.com/rich-iannone/pointblank/workflows/lint/badge.svg" alt="Linting" /></a>
<a href="https://codecov.io/gh/rich-iannone/pointblank?branch=master"><img src="https://codecov.io/gh/rich-iannone/pointblank/branch/master/graph/badge.svg" alt="Coverage status" /></a>
<a href="https://github.com/rstudio/pointblank/actions"><img src="https://github.com/rstudio/pointblank/workflows/R-CMD-check/badge.svg" alt="R build status" /></a>
<a href="https://github.com/rstudio/pointblank/actions"><img src="https://github.com/rstudio/pointblank/workflows/pkgdown/badge.svg" alt="Package Site" /></a>
<a href="https://github.com/rstudio/pointblank/actions"><img src="https://github.com/rstudio/pointblank/workflows/lint/badge.svg" alt="Linting" /></a>
<a href="https://codecov.io/gh/rstudio/pointblank?branch=master"><img src="https://codecov.io/gh/rstudio/pointblank/branch/master/graph/badge.svg" alt="Coverage status" /></a>
<a href="https://bestpractices.coreinfrastructure.org/projects/4310"><img src="https://bestpractices.coreinfrastructure.org/projects/4310/badge" alt="Best Practices"></a>
<a href="https://www.repostatus.org/#active"><img src="https://www.repostatus.org/badges/latest/active.svg" alt="The project has reached a stable, usable state and is being actively developed." /></a>
<a href="https://CRAN.R-project.org/package=pointblank"><img src="https://cranlogs.r-pkg.org/badges/pointblank" alt="Monthly Downloads"></a>
<a href="https://CRAN.R-project.org/package=pointblank"><img src="https://cranlogs.r-pkg.org/badges/grand-total/pointblank" alt="Total Downloads"></a>
<a href="https://www.contributor-covenant.org/version/2/0/code_of_conduct/"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
<a href="https://www.contributor-covenant.org/version/2/1/code_of_conduct.html"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
<!-- badges: end -->


Expand Down Expand Up @@ -43,25 +43,27 @@ install.packages("pointblank")
También puedes instalar la versión de desarrollo de **pointblank** desde **GitHub**:

``` r
devtools::install_github("rich-iannone/pointblank")
devtools::install_github("rstudio/pointblank")
```

Si encuentra un error, tiene preguntas de uso, o quiere compartir ideas para mejorar este paquete, no dudes en presentar un [issue](https://github.com/rich-iannone/pointblank/issues).
Si encuentra un error, tiene preguntas de uso, o quiere compartir ideas para mejorar este paquete, no dudes en presentar un [issue](https://github.com/rstudio/pointblank/issues).

## ¡Discutamos!

Hablemos de la validación de datos y de la documentación de datos en
[**pointblank** Discussions](https://github.com/rich-iannone/pointblank/discussions). Es un gran lugar para hacer preguntas sobre cómo usar el paquete, discutir algunas ideas, participar con otros y mucho más.
[**pointblank** Discussions](https://github.com/rstudio/pointblank/discussions). Es un gran lugar para hacer preguntas sobre cómo usar el paquete, discutir algunas ideas, participar con otros y mucho más.

## Código de conducta

Tenga en cuenta que el proyecto pointblank se publica con un [código de conducta para los colaboradores](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). Al participar en este proyecto, usted se compromete a respetar sus condiciones.
Tenga en cuenta que el proyecto pointblank se publica con un [código de conducta para los colaboradores](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). Al participar en este proyecto, usted se compromete a respetar sus condiciones.

## 📄 Licencia

**pointblank** está licenciado bajo la licencia MIT.
Consulte el archivo [`LICENSE.md`](LICENSE.md) para obtener más detalles.

© Posit Software, PBC.

## 🏛️ Gobernanza

Este proyecto es mantenido principalmente por [Rich Iannone](https://www.twitter.com/riannone). Otros autores pueden ayudar ocasionalmente en algunas de estas tareas.
Este proyecto es mantenido principalmente por [Rich Iannone](https://www.twitter.com/riannone). Otros autores pueden ayudar ocasionalmente en algunas de estas tareas.

0 comments on commit 19cb01e

Please sign in to comment.