Skip to content

Commit 04ac5ea

Browse files
Everton-da-CostaEverton-da-Costa
committed
Update README and initialize R package documentation?
0 parents  commit 04ac5ea

81 files changed

Lines changed: 12412 additions & 0 deletions

File tree

Some content is hidden

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

‎.Rbuildignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
^BarmaRidgeBJPS2025\.Rproj$
2+
^\.Rproj\.user$
3+
^LICENSE\.md$
4+
^doc$
5+
^Meta$
6+
^data-raw$

‎.github/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

‎.github/workflows/R-CMD-check.yaml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
8+
name: R-CMD-check.yaml
9+
10+
permissions: read-all
11+
12+
jobs:
13+
R-CMD-check:
14+
runs-on: ${{ matrix.config.os }}
15+
16+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
17+
18+
strategy:
19+
fail-fast: false
20+
matrix:
21+
config:
22+
- {os: macos-latest, r: 'release'}
23+
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
24+
- {os: ubuntu-latest, r: 'release'}
25+
- {os: ubuntu-latest, r: 'oldrel-1'}
26+
27+
env:
28+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
29+
R_KEEP_PKG_SOURCE: yes
30+
31+
steps:
32+
- uses: actions/checkout@v4
33+
34+
- uses: r-lib/actions/setup-pandoc@v2
35+
36+
- uses: r-lib/actions/setup-r@v2
37+
with:
38+
r-version: ${{ matrix.config.r }}
39+
http-user-agent: ${{ matrix.config.http-user-agent }}
40+
use-public-rspm: true
41+
42+
- uses: r-lib/actions/setup-r-dependencies@v2
43+
with:
44+
extra-packages: any::rcmdcheck
45+
needs: check
46+
47+
- uses: r-lib/actions/check-r-package@v2
48+
with:
49+
upload-snapshots: true
50+
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

‎.github/workflows/R.yml‎

Whitespace-only changes.

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.Rproj.user
2+
.Rhistory
3+
.Rdata
4+
.httr-oauth
5+
*.tar.gz

‎CODE_OF_CONDUCT.md‎

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

‎DESCRIPTION‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
Package: BarmaRidgeBJPS2025
2+
Title: Enhancements for Numerical Stability in Beta ARMA Models
3+
Version: 1.0.0
4+
Authors@R: c(
5+
person("Everton", "da Costa",
6+
email = "everto.cost@gmail.com",
7+
role = c("aut", "cre"),
8+
comment = c(ORCID = "0000-0001-7580-2639")
9+
),
10+
person("Rodney V.", "Fonseca",
11+
email = "rodneyfonseca@ufba.br",
12+
role = "ctb",
13+
comment = c(ORCID = "0000-0003-3948-3145")
14+
),
15+
person("Francisco", "Cribari-Neto",
16+
email = "francisco.cribari@ufpe.br",
17+
role = "ctb",
18+
comment = c(ORCID = "0000-0002-5909-6698")
19+
))
20+
Description: Implements a ridge penalization scheme to improve the numerical
21+
stability of conditional maximum likelihood estimation for Beta
22+
Autoregressive Moving Average (BARMA) models. The penalty term enhances
23+
the curvature of the log-likelihood function, reducing the risk of
24+
convergence failures and implausible estimates. The package also provides
25+
a bootstrap-based parameter estimation strategy as a complementary solution.
26+
These tools are designed to replicate the analysis and methods presented in
27+
Cribari-Neto, Costa, and Fonseca (2025).
28+
License: MIT + file LICENSE
29+
URL: https://github.com/everton-da-costa/BarmaRidgeBJPS2025
30+
BugReports: https://github.com/everton-da-costa/BarmaRidgeBJPS2025/issues
31+
Encoding: UTF-8
32+
LazyData: true
33+
RoxygenNote: 7.3.2
34+
RdMacros: Rdpack
35+
Imports:
36+
Rdpack,
37+
ggplot2,
38+
foreach,
39+
doMC,
40+
zoo,
41+
doRNG,
42+
stats,
43+
dplyr,
44+
gridExtra,
45+
scales
46+
Suggests:
47+
xtable,
48+
forecast,
49+
here,
50+
knitr,
51+
moments,
52+
rmarkdown,
53+
tseries
54+
VignetteBuilder: knitr
55+
Depends:
56+
R (>= 3.5)

‎LICENSE‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
YEAR: 2025
2+
COPYRIGHT HOLDER: Everton da Costa

‎NAMESPACE‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Generated by roxygen2: do not edit by hand
2+
3+
export(BARMAX_ridge_bootstrap_seasonal_parallel)
4+
export(barma)
5+
export(make_link_structure)
6+
export(simu_barma)
7+
import(doMC)
8+
import(foreach)
9+
importFrom(Rdpack,reprompt)
10+
importFrom(doMC,registerDoMC)
11+
importFrom(doRNG,"%dorng%")
12+
importFrom(dplyr,"%>%")
13+
importFrom(foreach,"%dopar%")
14+
importFrom(foreach,foreach)
15+
importFrom(ggplot2,ggplot)
16+
importFrom(gridExtra,grid.arrange)
17+
importFrom(stats,dbeta)
18+
importFrom(stats,fitted)
19+
importFrom(stats,frequency)
20+
importFrom(stats,is.ts)
21+
importFrom(stats,lm.fit)
22+
importFrom(stats,make.link)
23+
importFrom(stats,optim)
24+
importFrom(stats,pchisq)
25+
importFrom(stats,pnorm)
26+
importFrom(stats,rbeta)
27+
importFrom(stats,residuals)
28+
importFrom(stats,start)
29+
importFrom(stats,ts)
30+
importFrom(stats,var)
31+
importFrom(zoo,as.yearmon)

0 commit comments

Comments
 (0)