diff --git a/NAMESPACE b/NAMESPACE index 54df668..463c2aa 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -2,4 +2,6 @@ export("%>%") export(phenotypeCohort) +export(reportPhenotype) +export(shinyPhenotype) importFrom(magrittr,"%>%") diff --git a/R/reportPhenotype.R b/R/reportPhenotype.R new file mode 100644 index 0000000..f5be7b2 --- /dev/null +++ b/R/reportPhenotype.R @@ -0,0 +1,12 @@ + +#' Create a report summarising your phenotyping results +#' +#' @param result A summarised result +#' +#' @return A report +#' @export +#' +#' @examples +reportPhenotype <- function(result){ + +} diff --git a/R/shinyPhenotype.R b/R/shinyPhenotype.R new file mode 100644 index 0000000..8a1eb34 --- /dev/null +++ b/R/shinyPhenotype.R @@ -0,0 +1,12 @@ + +#' Create a shiny app summarising your phenotyping results +#' +#' @param result A summarised result +#' +#' @return A shiny app +#' @export +#' +#' @examples +shinyPhenotype <- function(result){ + +} diff --git a/README.Rmd b/README.Rmd index 6c023b4..7d145ae 100644 --- a/README.Rmd +++ b/README.Rmd @@ -20,6 +20,8 @@ knitr::opts_chunk$set( +> **This package is under development and not yet ready for use.** + [![R-CMD-check](https://github.com/oxford-pharmacoepi/phenotypeR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/oxford-pharmacoepi/phenotypeR/actions/workflows/R-CMD-check.yaml) [![Lifecycle:Experimental](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://lifecycle.r-lib.org/articles/stages.html#experimental) diff --git a/man/reportPhenotype.Rd b/man/reportPhenotype.Rd new file mode 100644 index 0000000..ada5d55 --- /dev/null +++ b/man/reportPhenotype.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/reportPhenotype.R +\name{reportPhenotype} +\alias{reportPhenotype} +\title{Create a report summarising your phenotyping results} +\usage{ +reportPhenotype(result) +} +\arguments{ +\item{result}{A summarised result} +} +\value{ +A report +} +\description{ +Create a report summarising your phenotyping results +} diff --git a/man/shinyPhenotype.Rd b/man/shinyPhenotype.Rd new file mode 100644 index 0000000..5b85ac5 --- /dev/null +++ b/man/shinyPhenotype.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/shinyPhenotype.R +\name{shinyPhenotype} +\alias{shinyPhenotype} +\title{Create a shiny app summarising your phenotyping results} +\usage{ +shinyPhenotype(result) +} +\arguments{ +\item{result}{A summarised result} +} +\value{ +A shiny app +} +\description{ +Create a shiny app summarising your phenotyping results +} diff --git a/tests/testthat/test-reportPhenotype.R b/tests/testthat/test-reportPhenotype.R new file mode 100644 index 0000000..8849056 --- /dev/null +++ b/tests/testthat/test-reportPhenotype.R @@ -0,0 +1,3 @@ +test_that("multiplication works", { + expect_equal(2 * 2, 4) +}) diff --git a/tests/testthat/test-shinyPhenotype.R b/tests/testthat/test-shinyPhenotype.R new file mode 100644 index 0000000..8849056 --- /dev/null +++ b/tests/testthat/test-shinyPhenotype.R @@ -0,0 +1,3 @@ +test_that("multiplication works", { + expect_equal(2 * 2, 4) +})