Skip to content

Commit

Permalink
Version 1.0.0 cont'd:
Browse files Browse the repository at this point in the history
  - Fixed notes before release
  • Loading branch information
entjos committed Oct 2, 2022
1 parent 9016f4a commit 2ff536e
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 19 deletions.
18 changes: 8 additions & 10 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
Package: ExclusionTable
Title: Creating Tables of Excluded Observations
Version: 1.0
Version: 1.0.0
Authors@R:
person(given = "Joshua P.",
family = "Entrop",
role = c("aut", "cre"),
email = "[email protected]",
comment = c(ORCID = "0000-0003-1614-8096"))
Description: This package can be used to keep track of the numbers of
observations that you exclude from your dataset. Instead of counting
observations before and after a subset() call, the ExclusionTable()
function reports the number before and after each subset() call together
with the number of observations that have been excluded. This is
especially usefull in observational studies for keeping track
how many observations have been excluded for each in-/ or
exclusion criteria. You just need tp provide ExclusionTable with a dataset
and a list of logical filter statements.
Description: Instead of counting observations before and after a `subset()`
call, the `ExclusionTable()` function reports the number before and after
each `subset()` call together with the number of observations that have been
excluded. This is especially useful in observational studies for keeping
track how many observations have been excluded for each in-/ or
exclusion criteria. You just need to provide `ExclusionTable()` with a
dataset and a list of logical filter statements.
License: CC BY 4.0
Encoding: UTF-8
URL: https://github.com/entjos/ExclusionTable
Expand Down
2 changes: 1 addition & 1 deletion R/exclusion_table.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#' `dplyr::filter()` or to `{data.table}`.
#'
#' @param data
#' A dataframe on wich the exclusions are to be performed.
#' A dataframe on which the exclusions are to be performed.
#'
#' @param exclusion_criteria
#' A character vector of logical expressions that are used for
Expand Down
4 changes: 2 additions & 2 deletions R/print.exl_tbl.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Prints `exl_tbl` objects
#'
#' This is print function for `exl_tbl` objects, which outputed by
#' `exlcusion_table()`. The function imporves the readability of the output.
#' This is a print function for `exl_tbl` objects, created with
#' `exlcusion_table()`. The function improves the readability of the output.
#'
#' @param x
#' An `exl_tbl` object.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ remotes::install_github("entjos/ExclusionTable")
library(ExclusionTable)
```
# Bugs
If you find any bugs or have any suggestions please don't hesitate to file an issue on GitHub or contact me via [my website](https://joshua-entrop.com), [Twitter](https://twitter.com/entjos) or [email](mailto:[email protected]).
If you find any bugs or have any suggestions please don't hesitate to file an issue on GitHub or contact me via [my website](https://joshua-entrop.com/), [Twitter](https://twitter.com/entjos) or [email](mailto:[email protected]).
12 changes: 11 additions & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
## R CMD check results
There were no ERRORs, WARNINGs, or NOTEs.
There were no ERRORs, or WARNINGs.

There was one NOTE on the Windows Server 2022, R-devel, 64 bit:

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

This can likely be ignored as discussed in r-hub issue [503](https://github.com/r-hub/rhub/issues/503).

## Downstream dependencies
There are currently no downstream dependencies for this package
2 changes: 1 addition & 1 deletion man/exclusion_table.Rd

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

4 changes: 2 additions & 2 deletions man/print.exl_tbl.Rd

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

2 changes: 1 addition & 1 deletion vignettes/ExclusionTable_vignette.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ exclusion_table(NHANES,

By supplying objects as names lists to the <TT>obj</TT> argument of <TT>exclusion_table</TT> we can access them in our filter calls using <TT>obj$\<name of your object\></TT>.

To summarise the <TT>ExclusionTable::exclusion_table()</TT> function allows you to easily keep track of your exclusion and inclusion criteria and helps you to report how many individuals you excluded at each step. If you have any questions or suggestions please write me an [email](mailto:[email protected]) or contact me on [Twitter](twitter.com/entjos) or file an issue on [GitHub](https://github.com/entjos/ExclusionTable).
To summaries the <TT>ExclusionTable::exclusion_table()</TT> function allows you to easily keep track of your exclusion and inclusion criteria and helps you to report how many individuals you excluded at each step. If you have any questions or suggestions please write me an [email](mailto:[email protected]) or contact me on [Twitter](twitter.com/entjos/) or file an issue on [GitHub](https://github.com/entjos/ExclusionTable/).

0 comments on commit 2ff536e

Please sign in to comment.