Skip to content

Commit

Permalink
Updating documentation, DESCRIPTION, NAMESPACE, and README based on R…
Browse files Browse the repository at this point in the history
… CRAN checks.
  • Loading branch information
salernos committed Oct 16, 2024
1 parent 7a6715a commit d08e474
Show file tree
Hide file tree
Showing 53 changed files with 1,539 additions and 183 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@
^_pkgdown\.yml$
^docs$
^pkgdown$
^dev$
^doc$
^Meta$
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
.quarto
docs
inst/doc
/doc/
/Meta/
57 changes: 40 additions & 17 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,29 +1,52 @@
Package: ipd
Title: Inference on Predicted Data
Version: 0.0.0.9000
Authors@R:
person("First", "Last", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "YOUR-ORCID-ID"))
Description: Peforms valid statistical inference on predicted data utilizing state-of-the-art methods. The package offers an all-encompassing wrapper function with specified defaults for ease of use and provides methods for tidying and summarizing results.
Version: 0.1.0
Authors@R: c(
person(given = "Stephen", family = "Salerno",
email = "[email protected]", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0003-2763-0494")),
person(given = "Jiacheng", family = "Miao",
email = "[email protected]", role = c("aut")),
person(given = "Awan", family = "Afiaz",
email = "[email protected]", role = c("aut")),
person(given = "Kentaro", family = "Hoffman",
email = "[email protected]", role = c("aut")),
person(given = "Anna", family = "Neufeld",
email = "[email protected]", role = c("aut")),
person(given = "Qiongshi", family = "Lu",
email = "[email protected]", role = c("aut")),
person(given = "Tyler H", family = "McCormick",
email = "[email protected]", role = c("aut")),
person(given = "Jeffrey T", family = "Leek",
email = "[email protected]", role = c("aut")))
Maintainer: Stephen Salerno <[email protected]>
Description: Peforms valid statistical inference on predicted data (IPD) using recent methods, where for a subset of the data, the outcomes have been predicted by an algorithm. Provides a wrapper function with specified defaults for the type of model and method to be used for estimation and inference. Further provides methods for tidying and summarizing results. Salerno et al., (2024) <doi:10.48550/arXiv.2410.09665>.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
LazyData: true
URL: https://github.com/ipd-tools/ipd
BugReports: https://github.com/ipd-tools/ipd/issues
Depends:
R (>= 3.5.0)
Imports:
caret,
gam,
generics,
ranger,
splines,
stats,
pspa,
generics
MASS,
randomForest
Suggests:
knitr,
rmarkdown,
tidyverse,
patchwork,
testthat (>= 3.0.0)
Remotes: qlu-lab/pspa
rmarkdown,
spelling,
testthat (>= 3.0.0),
tidyverse
VignetteBuilder:
knitr
Config/testthat/edition: 3
URL: https://github.com/awanafiaz/ipd
BugReports: https://github.com/awanafiaz/ipd/issues
VignetteBuilder: knitr
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
Language: en-US
15 changes: 14 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,25 @@ S3method(print,ipd)
S3method(print,summary.ipd)
S3method(summary,ipd)
S3method(tidy,ipd)
export(A)
export(Sigma_cal)
export(augment)
export(calc_lhat_glm)
export(compute_cdf)
export(compute_cdf_diff)
export(est_ini)
export(glance)
export(ipd)
export(link_Hessian)
export(link_grad)
export(log1pexp)
export(logistic_get_stats)
export(mean_psi)
export(mean_psi_pop)
export(ols)
export(ols_get_stats)
export(optim_est)
export(optim_weights)
export(postpi_analytic_ols)
export(postpi_boot_logistic)
export(postpi_boot_ols)
Expand All @@ -31,21 +40,25 @@ export(ppi_plusplus_ols_est)
export(ppi_plusplus_quantile)
export(ppi_plusplus_quantile_est)
export(ppi_quantile)
export(psi)
export(pspa_logistic)
export(pspa_mean)
export(pspa_ols)
export(pspa_poisson)
export(pspa_quantile)
export(pspa_y)
export(rectified_cdf)
export(rectified_p_value)
export(sim_data_y)
export(simdat)
export(tidy)
export(wls)
export(zconfint_generic)
export(zstat_generic)
import(MASS)
import(caret)
import(gam)
import(pspa)
import(randomForest)
import(stats)
importFrom(gam,gam)
importFrom(generics,augment)
Expand Down
Loading

0 comments on commit d08e474

Please sign in to comment.