Skip to content

Commit

Permalink
update doc to remove notes
Browse files Browse the repository at this point in the history
  • Loading branch information
bailliem committed Nov 20, 2023
1 parent 81744fc commit fc5502e
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 28 deletions.
3 changes: 0 additions & 3 deletions CRAN-SUBMISSION

This file was deleted.

18 changes: 10 additions & 8 deletions R/visr.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,19 @@
#' do a proposal.
#' @param y_ticks Ticks for the y-axis. When not specified,
#' the default will do a proposal based on the `fun` argument.
#'
#' @param fun Function that represents the scale of the estimate.
#' The current options are:
#' \itemize{
#' \item{`surv`}{ is the survival probability. This is the default.}
#' \item{`log`}{ is log of the survival probability}
#' \item{`event`}{ is the failure probability}
#' \item{`cloglog`}{ is log(-log(survival probability))}
#' \item{`pct`}{ is survival as a percentage}
#' \item{`logpct`}{ is log survival as a percentage}
#' \item{`cumhaz`}{ is the cumulative hazard}
#' \tabular{ll}{
#' \code{surv} \tab is the survival probability. This is the default \cr
#' \code{log} \tab is log of the survival probability \cr
#' \code{event} \tab is the failure probability \cr
#' \code{cloglog} \tab is log(-log(survival probability)) \cr
#' \code{pct} \tab is survival as a percentage \cr
#' \code{logpct} \tab is log survival as a percentage \cr
#' \code{cumhaz} \tab is the cumulative hazard \cr
#' }
#'
#' @param legend_position Specifies the legend position in the plot.
#' Character values allowed are "top" "left" "bottom" "right".
#' Numeric coordinates are also allowed.
Expand Down
35 changes: 26 additions & 9 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Resubmission
This is a resubmission. In this version I have:

* Resolved a warning from a failing test - see update below,
* Updated DESCRIPTION file to require latest version of survival (>= 3.4-0).
* added notes that we are deprecating visr.survfit() and visr.tidycuminc(), recommending the use of {ggsurvfit} instead.


## Test environments
* Ubuntu 18.04 LTS (on github actions), devel, release, oldrel-1, oldrel-2, oldrel-3, oldrel-4
Expand All @@ -12,10 +12,27 @@ This is a resubmission. In this version I have:

## R CMD check results

0 errors | 0 warnings | 0 note
Maintainer: 'Mark Baillie <[email protected]>'

New submission

Package was archived on CRAN

There were no ERRORs or WARNINGs.

There are 2 NOTEs I am aware of.

1. One is only found on Windows (Server 2022, R-devel 64-bit):

```
* checking for detritus in the temp directory ... NOTE
Found the following files/directories:
'lastMiKTeXException'
```

As noted in [R-hub issue #503](https://github.com/r-hub/rhub/issues/503), this may be due to a bug/crash in MiKTeX and can likely be ignored.


2. The second is

```
* checking for non-standard things in the check directory ... NOTE
Found the following files/directories:
''NULL''
```

As noted in [R-hub issue #560](https://github.com/r-hub/rhub/issues/560), this seems to be an Rhub issue and hopefully be ignored.
16 changes: 8 additions & 8 deletions man/visr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fc5502e

Please sign in to comment.