<commit_before>macroutils
==========

Page content: 
[Installation](#installation) &middot; 
[Official CKB release](#official) &middot; 
[Development version](#development) &middot; 
[Load and use the package](#usage) &middot; 
[Issues and bug reports](#issues) 



_R utility functions for the MACRO and SOILNDB models. Read and write_ 
_binary files, create plots, and more._

Author: **<NAME>** ([SLU][]/[CKB][]).
Package description: See [DESCRIPTION](/pkg/macroutils/DESCRIPTION).

Installation    <a id="installation"></a>
============

For all versions you need to install beforehand the sofware [R][] 
("a free software environment for statistical computing and graphics").

From R homepage, go to the [CRAN homepage][CRAN] or (better) choose 
the nearest [CRAN mirror][CRAN_mirrors].

From there, choose 'Download R for Windows' (or Mac or Linux), and 
then choose 'base' or 'install R for the First time'.

*   If you want to install the official CKB release (see below), you 
    must download the R version that corresponds to the package 
    requirement as indicated on `macroutils` / MACRO 5.2 homepage 
    on [CKB][] website (see below).

*   If you want to install the development version of macroutils (see 
    below), you can download latest R version, or (safer) the R 
    version that is indicated in the 
    [DESCRIPTION](/pkg/macroutils/DESCRIPTION) file.

Download the R installer, and install [R][] (follow the 
instructions).



Official [CKB][] release    <a id="official"></a>
------------------------

Note: _Windows only_ (the source package is not provided on this 
page).

On [MACRO 5.2 official homepage][MACRO], you can download the 
latest version of the package

The package binary Files are usually named `macroutils_x.y.z.zip`, 
where `x`, `y` and `z` form the version number (major milestone, 
minor milestone, minor revision).

Notice that you don't need to uncompress this `.zip` File! (it is 
an installer). Open R Graphical User Interface, and in the packages
menu (top menu bar), choose 'Install package(s) from local zip 
File(s)', and select the package binary File (`macroutils_x.y.z.zip`).



Development version    <a id="development"></a>
-------------------

Note: _May work on other platforms than Windows, but this has not_ 
_been tested_ ([MACRO][] only runs on Windows).

Note: _If you are not familiar with R (and R developments), you 
should probably avoid that method, as some complications may arise_.

The development version of `macroutils` is publicly available 
on [GitHub][] ([the page you are actually reading][macroutils_gh]). 
This page allows you to explore the package source code, to install 
the package development version (see below) and to report some 
[issues][macroutils_issues] (bugs)

*   On Windows computers, install [Rtools][] Install the 
    version that corresponds to your the version of R that is 
    installed on your computer. On other machines, read the 
    [instructions here][devtools_readme] (Windows users may also 
    have a look at this page).
    
*   Install the package [devtools][]. `devtools` is a package 
    developed by [<NAME>][HadleyWickham] to install 
    development version of R packages that are hosted on [GitHub][] 
    (among other useful things).
    
*   Open a new R cession and type `install.packages("devtools")`.
    Follow the additional [instructions here][devtools_readme].
    
*   Install the development version of `macroutils`. Open a new R 
    cession and type:


    devtools::install_github("julienmoeys/macroutils/pkg/macroutils")



Load and use the package    <a id="usage"></a>
------------------------

### Loading the package

Open R graphical user interface and type:

    library( "macroutils" )



### Package documentation (help pages)

To go further, you can access the help page by typing:

    help( package = "macroutils" )

There, see in particular the vignette (tutorial) in "User guides, 
package vignettes and other documentation" (to get started). You 
can also access that tutorial with the command

    vignette( "macroutils_vignette" )

Notice that if you have installed the development version from 
[GitHub][] the vignette may not have been generated with the 
package. But the vignette can be extracted from the package 
Windows binaries that can be downloaded on [MACRO][] homepage 
(`macroutils_x.y.z.zip` > `macroutils` > `doc` > 
`macroutils_vignette.pdf`).<commit_msg>typo (code example)<commit_after>macroutils
==========

Page content: 
[Installation](#installation) &middot; 
[Official CKB release](#official) &middot; 
[Development version](#development) &middot; 
[Load and use the package](#usage) &middot; 
[Issues and bug reports](#issues) 



_R utility functions for the MACRO and SOILNDB models. Read and write_ 
_binary files, create plots, and more._

Author: **<NAME>** ([SLU][]/[CKB][]).
Package description: See [DESCRIPTION](/pkg/macroutils/DESCRIPTION).

Installation    <a id="installation"></a>
============

For all versions you need to install beforehand the sofware [R][] 
("a free software environment for statistical computing and graphics").

From R homepage, go to the [CRAN homepage][CRAN] or (better) choose 
the nearest [CRAN mirror][CRAN_mirrors].

From there, choose 'Download R for Windows' (or Mac or Linux), and 
then choose 'base' or 'install R for the First time'.

*   If you want to install the official CKB release (see below), you 
    must download the R version that corresponds to the package 
    requirement as indicated on `macroutils` / MACRO 5.2 homepage 
    on [CKB][] website (see below).

*   If you want to install the development version of macroutils (see 
    below), you can download latest R version, or (safer) the R 
    version that is indicated in the 
    [DESCRIPTION](/pkg/macroutils/DESCRIPTION) file.

Download the R installer, and install [R][] (follow the 
instructions).



Official [CKB][] release    <a id="official"></a>
------------------------

Note: _Windows only_ (the source package is not provided on this 
page).

On [MACRO 5.2 official homepage][MACRO], you can download the 
latest version of the package

The package binary Files are usually named `macroutils_x.y.z.zip`, 
where `x`, `y` and `z` form the version number (major milestone, 
minor milestone, minor revision).

Notice that you don't need to uncompress this `.zip` File! (it is 
an installer). Open R Graphical User Interface, and in the packages
menu (top menu bar), choose 'Install package(s) from local zip 
File(s)', and select the package binary File (`macroutils_x.y.z.zip`).



Development version    <a id="development"></a>
-------------------

Note: _May work on other platforms than Windows, but this has not_ 
_been tested_ ([MACRO][] only runs on Windows).

Note: _If you are not familiar with R (and R developments), you 
should probably avoid that method, as some complications may arise_.

The development version of `macroutils` is publicly available 
on [GitHub][] ([the page you are actually reading][macroutils_gh]). 
This page allows you to explore the package source code, to install 
the package development version (see below) and to report some 
[issues][macroutils_issues] (bugs)

*   On Windows computers, install [Rtools][] Install the 
    version that corresponds to your the version of R that is 
    installed on your computer. On other machines, read the 
    [instructions here][devtools_readme] (Windows users may also 
    have a look at this page).
    
*   Install the package [devtools][]. `devtools` is a package 
    developed by [<NAME>][HadleyWickham] to install 
    development version of R packages that are hosted on [GitHub][] 
    (among other useful things).
    
*   Open a new R cession and type `install.packages("devtools")`.
    Follow the additional [instructions here][devtools_readme].
    
*   Install the development version of `macroutils`. Open a new R 
    cession and type:

<code>
    devtools::install_github("julienmoeys/macroutils/pkg/macroutils")
</code>


Load and use the package    <a id="usage"></a>
------------------------

### Loading the package

Open R graphical user interface and type:

    library( "macroutils" )



### Package documentation (help pages)

To go further, you can access the help page by typing:

    help( package = "macroutils" )

There, see in particular the vignette (tutorial) in "User guides, 
package vignettes and other documentation" (to get started). You 
can also access that tutorial with the command

    vignette( "macroutils_vignette" )

Notice that if you have installed the development version from 
[GitHub][] the vignette may not have been generated with the 
package. But the vignette can be extracted from the package 
Windows binaries that can be downloaded on [MACRO][] homepage 
(`macroutils_x.y.z.zip` > `macroutils` > `doc` > 
`macroutils_vignette.pdf`).
{'fraction_non_alphanumeric': 0.1087616691035879, 'fraction_numerical': 0.000899786300753571, 'mean_word_length': 3.8857142857142857, 'pattern_counts': {'":': 0, '<': 25, '<?xml version=': 0, '>': 31, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 16, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5667589', 'n_tokens_mistral': 2710, 'n_tokens_neox': 2497, 'n_words': 1131}