Changelog
Source:NEWS.md
ipd 0.1.3
CRAN release: 2024-12-03
Added a
NEWS.md
file to track changes to the package.Added a
pkgdown
site for the package.ipd()
now allows for regression through the origin withintercept = FALSE
argument.-
ipd()
now takes an additional argument,na_action
, to handle missing covariate data.Currently supports
"na.fail"
and"na.omit"
. Defaults tona.fail
.Provides a more informative error message and lists which covariates are missing observations.
ipd()
now takes an additional argument,n_t
, which denotes the (optional) size of the training set used to generate the prediction rule. Defaults toInf
but is necessary for thepostpi_X
methods ifn_t
<n
,N
, the number of labeled and unlabeled observations, respectively, in the data being analyzed.
ipd 0.1.4
CRAN release: 2025-01-07
Added a help topic for the package itself (
man/ipd-package.Rd
) viaR/ipd-package.R
androxygen2
-
Updated the documentation for
ipd()
:Provided a more explicit description of the
model
argument, which is meant to specify the downstream inferential model or parameter to be estimated.Clarified that not all columns in data are used in prediction unless explicitly referenced in the
formula
argument or in thelabel
argument if the data are passed as one stacked data frame.
Updated the documentation for
simdat()
to include a more thorough explanation of how to simulate data with this function.simdat()
now outputs adata.frame
with a column named"set_label"
instead of"set"
to denote the labeled/unlabeled observation indicator.
ipd 0.99.0
Summary:
Preparations to archive on CRAN and move to Bioconductor.
Slight formatting changes to conform to
styler
andlintr
suggestions.Added PPIa, Chen and Chen methods from Gronsbell et al. (2025) “Another look at inference after prediction.”
Specific Changes:
-
Version bump
- Pre‑release version set to 0.99.0 for Bioconductor devel.
-
DESCRIPTION updates
-
Depends: R (>= 4.4.0)
- Added
biocViews: Software
- Added
Suggests: BiocStyle, BiocManager
-
-
Vignettes
- Converted existing R Markdown vignettes to Bioconductor style with
BiocStyle::html_document
and properVignetteIndexEntry
headers. - Added examples for Chen and Chen, PPI “All” methods.
- Converted existing R Markdown vignettes to Bioconductor style with
-
NEWS & CITATION
- Added
NEWS.md
entry (this file) and aCITATION
file for package citation metadata.
- Added
-
Testing & QA
- Passed
BiocCheck
with no errors or warnings. - Updated
testthat
suite as needed for Bioc compliance.
- Passed
-
Continuous Integration
- Added GitHub Actions via
usethis::use_github_action("bioc-workflow")
to run Bioconductor checks on Linux, macOS, and Windows.
- Added GitHub Actions via
-
README
-
Installation instructions updated to:
if (!requireNamespace("BiocManager", quietly=TRUE)) install.packages("BiocManager") BiocManager::install("ipd")
-
Replaced CRAN build badge with:
-
-
New functions
-
ppi_a_ols()
— implements the PPIa estimator for prediction‑powered inference. -
chen_ols()
— implements the Chen & Chen estimator for inference on predicted data. -
.parse_inputs()
- helper to validate and split input data. -
.drop_unused_levels()
- helper to drop unused factor levels and report which were removed. -
.warn_differing_levels()
- helper to warn on differing factor levels between labeled and unlabeled data. -
.build_design()
- helper to build design matrices and outcome vectors. -
show()
- implements S4 method foripd
class.
-
- Updates to functions
-
Bioconductor submission prep
- Branch created, tag
v0.99.0
applied. - Will request CRAN archiving of the CRAN version upon successful Bioconductor acceptance.
- Branch created, tag