<commit_before># hwglabr
### Hochwagen lab R package

Compilation of functions used frequently by Hochwagen lab members.
This is a work in progress for the development of a more complete and useful package.

#### Installation

You can install the package directly from the source code on GitHub. For that you will need Hadley Wickham's `devtools` R package:
``` r
install.packages("devtools")
```

Once you have `devtools` you can install and load `hwglabr`:
``` r
devtools::install_github("luisvalesilva/hwglabr")
library(hwglabr)
```

#### Documentation

There is a (mostly up to date) [documentation website](http://www.nyu.edu/projects/hochwagen/hwglabr/).

Function documentation is accessible within R in the standard way, by typing `?function_name`. You can
also get the names of all included functions directly from within R using **`ls()`**:

``` r
library(hwglabr)
ls('package:hwglabr')
```<commit_msg>More detail on how to list included functions<commit_after># hwglabr
### Hochwagen lab R package

Compilation of functions used frequently by Hochwagen lab members.
This is a work in progress for the development of a more complete and useful package.

#### Installation

You can install the package directly from the source code on GitHub. For that you will need Hadley Wickham's `devtools` R package:
``` r
install.packages("devtools")
```

Once you have `devtools` you can install and load `hwglabr`:
``` r
devtools::install_github("luisvalesilva/hwglabr")
library(hwglabr)
```

#### Documentation

There is a (mostly up to date) [documentation website](http://www.nyu.edu/projects/hochwagen/hwglabr/).
Function documentation is accessible within R in the standard way, by typing one of the following:

``` r
help("function_name")

?function_name
```

You can also get the list of included functions directly from within R using one of the following:

``` r
ls('package:hwglabr')   # List function names

lsf.str("package:hwglabr")   # List function names and their arguments
```
{'fraction_non_alphanumeric': 0.09934771700953336, 'fraction_numerical': 0.0, 'mean_word_length': 5.23125, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6552960', 'n_tokens_mistral': 601, 'n_tokens_neox': 571, 'n_words': 246}