---
title: "Introduction to fcuk"
author: "Vincent Guyader"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Introduction to fcuk}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

# fcuk

A package designed to help people with clumsy fingers.

## Installation of `fcuk`

```R
if (!require(devtools)){install.packages("devtools")}
devtools::install_github("ThinkR-open/fcuk")
```

## Launch and use

After launching this package, every error will be analysed. Each time a typo occurs, a correction suggestion will be made under the default error message. 

```{r eval=FALSE}
library(fcuk)

# Examples 
sl()
> Error in sl() : impossible de trouver la fonction "sl"
Did you mean : ls or nls ?

iri
> Erreur : objet 'iri' introuvable
Did you mean : IQR or iris ?

view
> Erreur : objet 'view' introuvable
Did you mean : View or deriv ?

mea
> Erreur : objet 'mea' introuvable
Did you mean : mean or frame ?

```

## Stop `fcuk`

You can stop `fcuk` at anytime by calling the `remove_error_tracker` function. Start the error tracker again with `init_error_tracker`. 

## Recurrent use of fcuk

You can launch `fcuk` with your R session. 

```{r}
.First <- function(){
cat("\n Bonjour !  - ", date(), "\n") 
library(fcuk)
}
```

It will be more efficient to add this library to your Rprofile. You can use `fcuk::add_fcuk_to_rprofile()` to do so. Then, any time you launch your R project, `fcuk` will be launched at the same time. 

You can also add `fcuk` inside your `Rprofile.site` file. Then you'll have this functionnality inside all your Rstudio projects.

## fcuk functions

You'll typically never need to use the functions contained in `fcuk`. You just need to launch this library, and `fcuk` will do his job in the background. 

## Feedbacks and questions 

Feel free to  report any [issue](https://github.com/ThinkR-open/fcuk/issues) you may have with this package.