Skip to content

Commit

Permalink
Prepare for CRAN submission
Browse files Browse the repository at this point in the history
  • Loading branch information
boxuancui committed Jan 23, 2024
1 parent 8bb4fe9 commit da4a828
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 24 deletions.
3 changes: 2 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@
^cran-comments\.md$
^revdep$
^appveyor\.yml$
^code_of_conduct\.md$
^\.github$
report.html
report_files/
^README\.Rmd$
^README-.*\.png$
^pkgdown$
^CODE_OF_CONDUCT\.md$
^code_of_conduct\.md$
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ knitr::opts_chunk$set(
[![R-CMD-check](https://github.com/boxuancui/DataExplorer/actions/workflows/check-standard.yaml/badge.svg)](https://github.com/boxuancui/DataExplorer/actions/workflows/check-standard.yaml)
[![codecov](https://codecov.io/gh/boxuancui/DataExplorer/graph/badge.svg?token=w8eMGjF8Jw)](https://codecov.io/gh/boxuancui/DataExplorer)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2053/badge)](https://bestpractices.coreinfrastructure.org/projects/2053)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](http://boxuancui.github.io/DataExplorer/code_of_conduct.html)

## Background

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Stars](https://img.shields.io/github/stars/boxuancui/DataExplorer.svg?style=soci
[![CII Best
Practices](https://bestpractices.coreinfrastructure.org/projects/2053/badge)](https://bestpractices.coreinfrastructure.org/projects/2053)
[![Contributor
Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](http://boxuancui.github.io/DataExplorer/code_of_conduct.html)

## Background

Expand Down
17 changes: 5 additions & 12 deletions code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Contributor Covenant Code of Conduct

## Our Pledge
Expand Down Expand Up @@ -53,15 +52,15 @@ decisions when appropriate.

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
boxuancui at gmail dot com.
boxuancui at gmail dot com.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down Expand Up @@ -117,18 +116,12 @@ community.

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
<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][Mozilla CoC].
[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

2 changes: 2 additions & 0 deletions codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ coverage:
default:
target: auto
threshold: 1%
informational: true
patch:
default:
target: auto
threshold: 1%
informational: true
16 changes: 12 additions & 4 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ I have addressed the 2 NOTES in the Check Results page, i.e.,
* Missing `obj` definition
* `LazyData` is specified without a `data` directory

In addition, I am getting the following warning regarding Codecov.io. I copied them directly from the official page and tested them. My original URL is working fine and the suggested badge URL is not working. I am not sure what the problem is, so please advise on how to address it.

```
! Warning: README.md:12:13 Moved
[![codecov](https://codecov.io/gh/boxuancui/DataExplorer/graph/badge.svg?token=w8eMGjF8Jw)](https://codecov.io/gh/boxuancui/DataExplorer)
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
https://app.codecov.io/gh/boxuancui/DataExplorer
```

## Test environments
GitHub Actions:

Expand All @@ -17,9 +26,8 @@ GitHub Actions:

## R CMD check results

0 errors | 0 warnings | 0 note
The only outstanding note is what I described above.

* This is a new release.
❯ checking CRAN incoming feasibility ... [6s/49s] NOTE Maintainer: ‘Boxuan Cui <[email protected]> Found the following (possibly) invalid URLs: URL: https://codecov.io/gh/boxuancui/DataExplorer (moved to https://app.codecov.io/gh/boxuancui/DataExplorer) From: README.md Status: 200 Message: OK 0 errors ✔ | 0 warnings ✔ | 1 note ✖

## Reverse dependencies
0 packages with problems
## revdepcheck resultsWe checked 1 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package. * We saw 0 new problems * We failed to check 0 packages
Expand Down
5 changes: 0 additions & 5 deletions revdep/email.yml

This file was deleted.

0 comments on commit da4a828

Please sign in to comment.