bfftesting

:package: The Title of the Project

https://github.com/rshudde/bfftesting

Repository

:package: The Title of the Project

README.Rmd

---
output: github_document
---




```{r, include = FALSE}
knitr::opts_chunk$set(collapse  = TRUE,
                      comment   = "#>",
                      fig.path  = "man/figures/",
                      out.width = "100%")
```



BFFTESTING 
=========================================================


[![CRAN status](https://www.r-pkg.org/badges/version/BFFTESTING)](https://CRAN.R-project.org/package=BFFTESTING)
[![R CMD Check](https://github.com/rshudde/BFFTESTING/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rshudde/BFFTESTING/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/rshudde/BFFTESTING/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/rshudde/BFFTESTING/actions/workflows/pkgdown.yaml)
[![Test coverage](https://github.com/rshudde/BFFTESTING/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/rshudde/BFFTESTING/actions/workflows/test-coverage.yaml)
[![codecov](https://codecov.io/gh/rshudde/BFFTESTING/branch/master/graph/badge.svg)](https://codecov.io/gh/rshudde/BFFTESTING)
[![License: GPL (>= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)





  • Overview

  • Features

  • Installation

  • Get started

  • Long-form documentations

  • Citation

  • Contributing

  • Acknowledgments

  • References




## Overview


The R package `BFFTESTING`... **{{ DESCRIBE YOUR PACKAGE }}**



## Features

The main purpose of `BFFTESTING` is to... **{{ DESCRIBE THE MAIN FEATURES }}**



## Installation

You can install the development version from [GitHub](https://github.com/) with:

```{r eval=FALSE}
## Install < remotes > package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}

## Install < BFFTESTING > from GitHub ----
remotes::install_github("rshudde/BFFTESTING")
```

Then you can attach the package `BFFTESTING`:

```{r eval=FALSE}
library("BFFTESTING")
```



## Get started

For an overview of the main features of `BFFTESTING`, please read the 
[Get started](https://rshudde.github.io/BFFTESTING/articles/BFFTESTING.html)
vignette.



## Long-form documentations

`BFFTESTING` provides **{{ NUMBER OF VIGNETTES }}** vignettes to learn more about the package:

- the [Get started](https://rshudde.github.io/BFFTESTING/articles/BFFTESTING.html)
vignette describes the core features of the package
- **{{ LIST ADDITIONAL VIGNETTES }}**



## Citation

Please cite `BFFTESTING` as: 

> shudde rachael (`r format(Sys.Date(), "%Y")`) BFFTESTING: An R 
package to **{{ TITLE }}**. R package version 0.0.0.9000. 




## Contributing

All types of contributions are encouraged and valued. For more information, 
check out our [Contributor Guidelines](https://github.com/rshudde/BFFTESTING/blob/main/CONTRIBUTING.md).

Please note that the `BFFTESTING` project is released with a 
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). 
By contributing to this project, you agree to abide by its terms.



## Acknowledgments

**{{ OPTIONAL SECTION }}**



## References

**{{ OPTIONAL SECTION }}**

Owner

Citation (CITATION.cff)

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.5.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "BFFTESTING" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'BFFTESTING: The Title of the Project'
version: 0.0.0.9000
abstract: A paragraph providing a full description of the project (on several lines...)
authors:
- family-names: shudde
  given-names: rachael
  email: rachael.shudde@gmail.com
  orcid: https://orcid.org/orcid
preferred-citation:
  type: manual
  title: 'BFFTESTING: An R package to ...'
  authors:
  - name: shudde rachael
  year: '2023'
  notes: R package version 0.0.0.9000
  url: https://github.com/rshudde/BFFTESTING
repository-code: https://github.com/rshudde/BFFTESTING
url: https://github.com/rshudde/BFFTESTING
contact:
- family-names: shudde
  given-names: rachael
  email: rachael.shudde@gmail.com
  orcid: https://orcid.org/orcid
references:
- type: software
  title: knitr
  abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
  notes: Suggests
  url: https://yihui.org/knitr/
  repository: https://CRAN.R-project.org/package=knitr
  authors:
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  year: '2023'
- type: software
  title: rmarkdown
  abstract: 'rmarkdown: Dynamic Documents for R'
  notes: Suggests
  url: https://pkgs.rstudio.com/rmarkdown/
  repository: https://CRAN.R-project.org/package=rmarkdown
  authors:
  - family-names: Allaire
    given-names: JJ
    email: jj@posit.co
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  - family-names: Dervieux
    given-names: Christophe
    email: cderv@posit.co
    orcid: https://orcid.org/0000-0003-4474-2498
  - family-names: McPherson
    given-names: Jonathan
    email: jonathan@posit.co
  - family-names: Luraschi
    given-names: Javier
  - family-names: Ushey
    given-names: Kevin
    email: kevin@posit.co
  - family-names: Atkins
    given-names: Aron
    email: aron@posit.co
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  - family-names: Cheng
    given-names: Joe
    email: joe@posit.co
  - family-names: Chang
    given-names: Winston
    email: winston@posit.co
  - family-names: Iannone
    given-names: Richard
    email: rich@posit.co
    orcid: https://orcid.org/0000-0003-3925-190X
  year: '2023'
- type: software
  title: testthat
  abstract: 'testthat: Unit Testing for R'
  notes: Suggests
  url: https://testthat.r-lib.org
  repository: https://CRAN.R-project.org/package=testthat
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2023'
  version: '>= 3.0.0'

GitHub Events