Skip to content

cran suggestions - #6

Open
Polkas wants to merge 2 commits into
mainfrom
cran_submission_changes
Open

Polkas wants to merge 2 commits into
mainfrom
cran_submission_changes

Conversation

@Polkas

@Polkas Polkas commented Nov 2, 2026 •

Copy link
Copy Markdown
Collaborator
  • Please omit the redundant "with R" at the end of your title.
  • Please add \value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \value{No return value, called for side effects} or similar) For more details: https://contributor.r-project.org/cran-cookbook/docs_issues.html#missing-value-tags-in-.rd-files -> Missing Rd-tags:
    as.data.frame.bssd_binary_map.Rd: \value
    as.data.frame.bssd_binary.Rd: \value
    plot.bssd_binary_map.Rd: \value
    plot.bssd_binary.Rd: \value
    print.bssd_binary_map.Rd: \value
    print.bssd_binary.Rd: \value
    summary.bssd_binary_map.Rd: \value
    summary.bssd_binary.Rd: \value

@Polkas
Polkas requested a review from NilsPenard November 2, 2026 18:10
Comment thread R/approx_bssd.R Resolved
Comment thread R/approx_bssd_graph.R Resolved
Comment thread R/bssd_binary.R Resolved
Comment thread R/bssd_binary.R Resolved
Comment thread R/bssd_binary.R Resolved
Comment thread R/bssd_binary.R Resolved
Comment thread R/bssd_binary_map.R Resolved
Comment thread R/bssd_binary_map.R Outdated
#' @param mcmc MCMC flag.
#' @param alpha if not null, 1 - alpha confidence interval is calculated.
#' @param ... extra parameters are passed to \code{\link{stan_bssd}}.
#' @return Invisibly returns \code{NULL}. Called for the side effect of printing

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#' @return No return value, called for side effects. The method prints the
#' posterior mean event probability and the meta-analytic-predictive event
#' probability for a new exchangeable trial, together with their highest
#' posterior density intervals. If mcmc = TRUE, the underlying Stan fit is
#' also printed.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied

Comment thread R/bssd_binary_map.R Resolved
Comment thread R/bssd_binary_map.R Resolved
Comment thread R/bssd_binary_map.R Resolved
Comment thread R/stan_bssd.R Resolved
Comment thread R/stan_map_patient_data.R Resolved
Comment thread R/stan_map_summary_data.R Resolved
Comment thread R/forest_plot.R Outdated

@NilsPenard NilsPenard Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these classes are not necessary anymore and were probably some legacy classes that have not been kept: "bssd_binary_map_sl" and "bssd_binary_map_pl". I could not find any other references in the code or documentation.

Suggested change
if (!(any(class(x) %in% c("bssd_binary_map",
"bssd_map")))) {

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants