Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prep for version 1.0.0 #6

Merged
merged 76 commits into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
76 commits
Select commit Hold shift + click to select a range
3fc9f6b
adds save_obj function
francojc Mar 12, 2024
82ca841
adds save_tbl function
francojc Mar 12, 2024
a8f0bfe
updates namespace
francojc Mar 12, 2024
9a41b9d
adds save_fig function
francojc Mar 12, 2024
cf7692b
updates imports
francojc Mar 12, 2024
c74605d
updates to include device switch
francojc Mar 12, 2024
b42ccb0
adds write_*() functions for publishing
francojc Mar 12, 2024
cd8787d
bump minor version for write_ functions
francojc Mar 12, 2024
c7b12c7
Merge pull request #3 from qtalr/save-functions
francojc Mar 14, 2024
7118503
try to get windows to work with webshot2
francojc Mar 15, 2024
bd90a31
sets chromote timeout to 60 seconds (instead of default 10)
francojc Mar 15, 2024
5fe3b33
adds function to add pkgs to bib entries
francojc Mar 15, 2024
0e6c657
documents fix for windows chromote build issue
francojc Mar 15, 2024
2fb35c4
chore: Update package version to 0.12.0 and add new function to add p…
francojc May 20, 2024
24296b4
adjusts for 0.11 release
francojc May 20, 2024
f1bd598
Merge branch 'release-0.10' into release-0.12
francojc Jun 14, 2024
1cac742
Updates example to run, removes donotrun
francojc Jun 14, 2024
ed19f43
Merge branch 'release-0.12' into latest
francojc Jun 14, 2024
ee74dd4
Notes delayed doi activation date
francojc Jun 16, 2024
83cb839
Amends add_pkg_to_bib example
francojc Jun 20, 2024
c9116ec
Amends create_data_origin example
francojc Jun 20, 2024
b4ff364
Modifies the functions. Adds dontrun due to issues with writing file…
francojc Jun 22, 2024
0c00dd9
Updates function and tests
francojc Jun 22, 2024
c0bc8bf
updates example
francojc Jun 22, 2024
9c9093f
adds kableExtra::kable_save
francojc Jun 22, 2024
f616b35
Adds 'latest' branch to gh action r-check
francojc Jun 22, 2024
123f7db
Updates to readme
francojc Jul 4, 2024
acb9e29
merge fixes
francojc Jul 4, 2024
9249ae3
Adds issue temp
francojc Jul 4, 2024
78f2299
find_outliers fun
francojc Jul 4, 2024
11b2282
github actions
francojc Jul 4, 2024
d399e2e
find_outliers
francojc Jul 4, 2024
b50dd2c
Updates pkgdown site structure and news
francojc Jul 4, 2024
ed52c53
updates calc_type_metrics
francojc Aug 3, 2024
7bd1a57
Adds flake and amends ignore
francojc Aug 4, 2024
ff072ea
Adds gettext, languageserver, and sessioninfo to the environment
francojc Aug 5, 2024
3edf967
Adds lines to Rbuildignore for flake activity
francojc Aug 5, 2024
5951d01
Updates and improves calc_assoc_metrics and calc_type_metrics functions
francojc Aug 5, 2024
75a90aa
Adds prelim get_gutenberg_data function
francojc Aug 6, 2024
bfd1f13
Adds placeholders for new functions. Also formats functions for pkgdo…
francojc Aug 6, 2024
65f5b7c
Adds frequency measures to the dispersions calc_disp function
francojc Aug 7, 2024
31e3095
Updates to env: adds local Lib path and local nixPkgs
francojc Aug 7, 2024
64e4706
Adds prelim create_data_dictionary function
francojc Aug 7, 2024
a092456
Adds tests for calc_disp and calc_type_metrics
francojc Aug 14, 2024
c694e5f
updates flake to include fs and tidyr
francojc Aug 14, 2024
4b936b7
Updates version to 1.0.0 and doi
francojc Aug 14, 2024
50d8659
adds dataset for calc_assoc_metrics
francojc Aug 15, 2024
e0fd526
updates readme with new qtalr.com url
francojc Aug 15, 2024
c0b0091
ignores lintr file
francojc Aug 15, 2024
847c1a8
updates write_*() functions' examples
francojc Aug 15, 2024
201cfb5
adds get_talkbank_data function
francojc Aug 15, 2024
ea7c5ac
updates get_gutenberg_data example
francojc Aug 15, 2024
90a092d
updates get_archive_data example
francojc Aug 15, 2024
ffdbf2d
updates calc_assoc_metrics example and fixes verbose = TRUE output
francojc Aug 15, 2024
6c109fc
removes redundant library call
francojc Aug 15, 2024
2ea57cc
adds tests for calc_assoc_metrics, create_data_dictionary, get_gutenb…
francojc Aug 15, 2024
2362fcc
Update issue templates
francojc Aug 16, 2024
4737ffb
updated documentation for the functions
francojc Aug 16, 2024
3dd48a4
adds new exports, package functions and external functions
francojc Aug 16, 2024
bcb5497
tweaks to examples and docstring
francojc Aug 16, 2024
2bafbe2
remove package vignette
francojc Aug 16, 2024
0a48e03
update descriptiom, news, and pkgdown site
francojc Aug 16, 2024
16db8fa
updates to issues templates
francojc Aug 16, 2024
71a84ee
updates get_talkbank_data to suppress messages cross-platform
francojc Aug 16, 2024
53bb9b1
explicitly imports functions from TBDBr
francojc Aug 16, 2024
e249d07
updates urls
francojc Aug 16, 2024
989a4bf
updates badges
francojc Aug 16, 2024
441c8da
adds httr and httptest for development and tests
francojc Aug 16, 2024
fb00e26
Try to avoid side-effects from webshot2
francojc Aug 16, 2024
b89bbfa
mocks api request to talkbank
francojc Aug 16, 2024
8c897c1
formatting changes to test-get_gutenberg_data
francojc Aug 16, 2024
29dbf5b
Merge pull request #5 from qtalr/francojc-issue-templates-1
francojc Aug 16, 2024
69a8209
creates issue templates and adds conduct and contributing documents
francojc Aug 16, 2024
b68a456
adds contributing to the Rbuildignore file
francojc Aug 16, 2024
af13784
minimal version of R for native pipe
francojc Aug 16, 2024
9ec9dbb
testing formatting changes to overcome HTML validation notes on checks
francojc Aug 16, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
^_pkgdown\.yml$
^docs$
^pkgdown$
^\.direnv$
^\.DS_Store$
^\.envrc$
^\.github$
^\.lintr$
^\.Rproj\.user$
^CONTRIBUTING.md$
^cran-comments\.md$
^CRAN-SUBMISSION$
^Crashpad$
^data-raw$
^doc$
^docs$
^flake\.lock$
^flake\.nix$
^Meta$
^README\.Rmd$
^cran-comments\.md$
^qtkit\.Rproj$
^\.Rproj\.user$
^qtkit\.code-workspace$
^.github$
^Library$
^LICENSE\.md$
^pkgdown$
^README\.Rmd$
^vignettes/articles$
^.DS_Store$
^CRAN-SUBMISSION$
6 changes: 6 additions & 0 deletions .Rprofile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Add local library to the search path
# for packages not on Nix
.libPaths(new = c("Library", .libPaths()))

# Set CRAN mirror
options(repos = c(CRAN = "https://cran.rstudio.com"))
1 change: 1 addition & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
use flake
126 changes: 126 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

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 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 codeofconduct@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.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

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>.

Community Impact Guidelines were inspired by
[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>. Translations are available at <https://www.contributor-covenant.org/translations>.

[homepage]: https://www.contributor-covenant.org
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve qtkit
---

### Tips for a helpful bug report:

- If you have a question, please don't use this form. Instead, ask on:

1. <https://github.com/qtalr/discussions>
2. <https://community.rstudio.com/>
3. <https://stackoverflow.com/>

- Please include a **minimal reproducible example**, a reprex, to demonstrate the bug.
If you've never heard of a reprex, please read ["Make a reprex"](https://www.tidyverse.org/help/#reprex).
Do not include session info unless it is explicitly asked for.

- If you can, use one of the built-in R datasets or a small toy dataset that exposes the bug.
If for some reason, the bug only occurs on your original data, try to limit the number of rows that are necessary to expose the bug.
Share such data by copying `dput()` output rather than an external file.

- Please check whether somebody has reported the same problem in the [issues](https://github.com/qtalr/qtkit/issues).

Delete these instructions once you have read them.

---

I found a problem with ...

I expected ...

Here is the code to reproduce the bug:

```r
# copy your code to the clipboard and run:
reprex::reprex()
```
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: qtalr Community Discussion
url: https:://github.com/qtalr/discussions
about: Please ask questions and discuss here.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: 'Feature Request'
about: Suggest a change or new feature in qtkit
---

### Tips for a helpful feature request:

- If you have a question, please don't use this form. Instead, ask on:

1. <https://github.com/qtalr/discussions>
2. <https://community.rstudio.com/>
3. <https://stackoverflow.com/>

- See the [contributing guidelines](https://github.com/qtalr/qtkit/blob/main/CONTRIBUTING.md).

- qtkit is a package primarily aimed a supporting the textbook ["An Introduction to Quantitative Text Analysis: Reproducible Research Using R"](https://qtalr.com/). Therefore, consider whether the functionality you propose will enhance and extend this goal. Improvements to its current functionality or to infrastructure are considered in scope for feature requests.

- Please motivate the need for change, if applicable with a **minimal reproducible** example (reprex).
If you've never heard of a reprex, please read ["Make a reprex"](https://www.tidyverse.org/help/#reprex).
Do not include session info unless it is explicitly asked for.

Delete this instructions once you've read them.

---

In situations when ...

I would like to be able to ...

```r
# copy your code to the clipboard and run:
reprex::reprex()
```
8 changes: 6 additions & 2 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
branches: [main, latest]
pull_request:
branches: [main, master]
branches: [main, latest]

name: R-CMD-check

Expand Down Expand Up @@ -39,6 +39,10 @@ jobs:
http-user-agent: ${{ matrix.config.http-user-agent }}
use-public-rspm: true

- name: Setup Chrome
if: runner.os == 'Windows'
uses: browser-actions/setup-chrome@latest

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::rcmdcheck
Expand Down
25 changes: 12 additions & 13 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
# RStudio
.Rproj.user
# R
.Rhistory
.Rdata
.Ruserdata
.Renviron
*.Rproj

# VSCode
*.code-workspace
.lintr

# R
.httr-oauth
data-raw
# Package
data-raw/
inst/doc
vignettes/articles/_site/
vignettes/articles/data/
docs/
Meta/

# Flake
.direnv/

# macOS
.DS_Store

# Misc
*_cache
packages.bib
docs
/doc/
/Meta/
doc/
Library/
.lintr

Loading