Skip to content

Commit ec3a8d6

Browse files
committed
Update unconfoundedr documentation
1 parent 7b22b30 commit ec3a8d6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1511
-127
lines changed

packages/myrpackage/404.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/myrpackage/404.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Content not found. Please use links in the navbar.
2+
3+
# Page not found (404)

packages/myrpackage/CODE_OF_CONDUCT.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in
6+
our community a harassment-free experience for everyone, regardless of
7+
age, body size, visible or invisible disability, ethnicity, sex
8+
characteristics, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance,
10+
race, caste, color, religion, or sexual identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open,
13+
welcoming, diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our
24+
mistakes, and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political
33+
attacks
34+
- Public or private harassment
35+
- Publishing others’ private information, such as a physical or email
36+
address, without their explicit permission
37+
- Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our
43+
standards of acceptable behavior and will take appropriate and fair
44+
corrective action in response to any behavior that they deem
45+
inappropriate, threatening, offensive, or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or
48+
reject comments, commits, code, wiki edits, issues, and other
49+
contributions that are not aligned to this Code of Conduct, and will
50+
communicate reasons for moderation decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also
55+
applies when an individual is officially representing the community in
56+
public spaces. Examples of representing our community include using an
57+
official e-mail address, posting via an official social media account,
58+
or acting as an appointed representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may
63+
be reported to the community leaders responsible for enforcement at
64+
<[email protected]>. All complaints will be reviewed and investigated
65+
promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security
68+
of the reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in
73+
determining the consequences for any action they deem in violation of
74+
this Code of Conduct:
75+
76+
### 1. Correction
77+
78+
**Community Impact**: Use of inappropriate language or other behavior
79+
deemed unprofessional or unwelcome in the community.
80+
81+
**Consequence**: A private, written warning from community leaders,
82+
providing clarity around the nature of the violation and an explanation
83+
of why the behavior was inappropriate. A public apology may be
84+
requested.
85+
86+
### 2. Warning
87+
88+
**Community Impact**: A violation through a single incident or series of
89+
actions.
90+
91+
**Consequence**: A warning with consequences for continued behavior. No
92+
interaction with the people involved, including unsolicited interaction
93+
with those enforcing the Code of Conduct, for a specified period of
94+
time. This includes avoiding interactions in community spaces as well as
95+
external channels like social media. Violating these terms may lead to a
96+
temporary or permanent ban.
97+
98+
### 3. Temporary Ban
99+
100+
**Community Impact**: A serious violation of community standards,
101+
including sustained inappropriate behavior.
102+
103+
**Consequence**: A temporary ban from any sort of interaction or public
104+
communication with the community for a specified period of time. No
105+
public or private interaction with the people involved, including
106+
unsolicited interaction with those enforcing the Code of Conduct, is
107+
allowed during this period. Violating these terms may lead to a
108+
permanent ban.
109+
110+
### 4. Permanent Ban
111+
112+
**Community Impact**: Demonstrating a pattern of violation of community
113+
standards, including sustained inappropriate behavior, harassment of an
114+
individual, or aggression toward or disparagement of classes of
115+
individuals.
116+
117+
**Consequence**: A permanent ban from any sort of public interaction
118+
within the community.
119+
120+
## Attribution
121+
122+
This Code of Conduct is adapted from the [Contributor
123+
Covenant](https://www.contributor-covenant.org), version 2.1, available
124+
at
125+
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
126+
127+
Community Impact Guidelines were inspired by [Mozilla’s code of conduct
128+
enforcement ladder](https://github.com/mozilla/diversity).
129+
130+
For answers to common questions about this code of conduct, see the FAQ
131+
at <https://www.contributor-covenant.org/faq>. Translations are
132+
available at <https://www.contributor-covenant.org/translations>.

packages/myrpackage/CONTRIBUTING.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
# Contributing to myrpackage
2+
3+
Thank you for considering contributing to myrpackage! This document
4+
provides guidelines for contributing to the project.
5+
6+
## Code of Conduct
7+
8+
Please note that the myrpackage project is released with a [Contributor
9+
Code of
10+
Conduct](https://diogoribeiro7.github.io/packages/myrpackage/CODE_OF_CONDUCT.md).
11+
By participating in this project you agree to abide by its terms.
12+
13+
## How to Contribute
14+
15+
### Reporting Bugs
16+
17+
If you find a bug, please create an issue on GitHub with the following
18+
information:
19+
20+
1. A clear title and description
21+
2. Steps to reproduce the behavior
22+
3. Expected behavior
23+
4. Actual behavior
24+
5. Environment details (R version, package version, OS)
25+
6. If possible, a minimal reproducible example
26+
27+
### Suggesting Enhancements
28+
29+
For feature requests, please create an issue on GitHub with:
30+
31+
1. A clear title and description
32+
2. Why this feature would be useful
33+
3. Example code showing how the feature would be used
34+
4. Any relevant references or context
35+
36+
### Pull Requests
37+
38+
1. Fork the repository
39+
2. Create a new branch for your feature or bugfix
40+
3. Make your changes
41+
4. Add tests for your changes
42+
5. Ensure all tests pass with `devtools::test()`
43+
6. Update documentation with `devtools::document()`
44+
7. Run R CMD check with `devtools::check()`
45+
8. Submit a pull request
46+
47+
## Development Workflow
48+
49+
### Setting Up Development Environment
50+
51+
1. Clone the repository
52+
2. Open the project in RStudio (or your preferred R IDE)
53+
3. Install development dependencies:
54+
55+
``` r
56+
# Install development dependencies
57+
devtools::install_dev_deps()
58+
59+
# Install the package in development mode
60+
devtools::load_all()
61+
```
62+
63+
### Running Tests
64+
65+
``` r
66+
# Run all tests
67+
devtools::test()
68+
69+
# Run specific tests
70+
testthat::test_file("tests/testthat/test-hello.R")
71+
72+
# Check test coverage
73+
covr::package_coverage()
74+
```
75+
76+
### Documentation
77+
78+
``` r
79+
# Generate documentation
80+
devtools::document()
81+
82+
# Preview documentation
83+
devtools::dev_help("hello")
84+
85+
# Build vignettes
86+
devtools::build_vignettes()
87+
88+
# Build README
89+
devtools::build_readme()
90+
```
91+
92+
### Code Style
93+
94+
We follow the [tidyverse style guide](https://style.tidyverse.org/).
95+
Please ensure your code adheres to this style.
96+
97+
You can use the following tools to check and fix style issues:
98+
99+
``` r
100+
# Check code style
101+
lintr::lint_package()
102+
103+
# Auto-format code
104+
styler::style_pkg()
105+
```
106+
107+
### Commit Messages
108+
109+
Please use clear and descriptive commit messages. We recommend following
110+
the [conventional commits](https://www.conventionalcommits.org/)
111+
specification:
112+
113+
- `feat`: A new feature
114+
- `fix`: A bug fix
115+
- `docs`: Documentation changes
116+
- `style`: Changes that do not affect code behavior (formatting, etc.)
117+
- `refactor`: Code changes that neither fix a bug nor add a feature
118+
- `test`: Adding or fixing tests
119+
- `chore`: Changes to the build process or auxiliary tools
120+
121+
### Pre-commit Checks
122+
123+
Before committing, please run:
124+
125+
``` r
126+
# Document the package
127+
devtools::document()
128+
129+
# Run tests
130+
devtools::test()
131+
132+
# Run R CMD check
133+
devtools::check()
134+
```
135+
136+
## Release Process
137+
138+
1. Update version number in DESCRIPTION
139+
2. Update NEWS.md with changes
140+
3. Run full checks:
141+
142+
``` r
143+
devtools::check()
144+
rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"))
145+
```
146+
147+
4. Build the package:
148+
149+
``` r
150+
devtools::build()
151+
```
152+
153+
5. Tag the release in Git:
154+
155+
``` r
156+
usethis::use_git_tag("v0.1.0")
157+
```
158+
159+
## Getting Help
160+
161+
If you need help or have questions, you can:
162+
163+
- Open an issue on GitHub
164+
- Reach out to the package maintainer: Diogo Ribeiro
165+
166+
167+
Thank you for contributing!

packages/myrpackage/LICENSE-text.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# License
2+
3+
YEAR: 2025
4+
COPYRIGHT HOLDER: Diogo Ribeiro

packages/myrpackage/LICENSE.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/myrpackage/LICENSE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# MIT License
2+
3+
Copyright (c) 2025 Diogo Ribeiro
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a
6+
copy of this software and associated documentation files (the
7+
“Software”), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included
14+
in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS
17+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)