https://github.com/mrcaseb/personalr

Automated Personal Package Setup
https://github.com/mrcaseb/personalr

Last synced: about 1 month ago
JSON representation

Automated Personal Package Setup

• Host: GitHub
• URL: https://github.com/mrcaseb/personalr
• Owner: mrcaseb
• License: other
• Created: 2020-10-29T12:48:58.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-11T22:03:36.000Z (over 2 years ago)
• Last Synced: 2024-09-23T01:57:51.832Z (3 months ago)
• Language: R
• Homepage: https://mrcaseb.github.io/personalr/
• Size: 5.22 MB
• Stars: 13
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - mrcaseb/personalr - Automated Personal Package Setup (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# personalr 

[![CRAN status](https://www.r-pkg.org/badges/version-ago/personalr)](https://CRAN.R-project.org/package=personalr)

[![CRAN downloads](http://cranlogs.r-pkg.org/badges/grand-total/personalr)](https://CRAN.R-project.org/package=personalr)

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![R-CMD-check](https://github.com/mrcaseb/personalr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mrcaseb/personalr/actions/workflows/R-CMD-check.yaml)

## Preface

If you work with R or any other programming language for a while, you will come to the point where you want to use already written code when developing a script and often need the same packages to do your work.The easiest solution is to save the loading of the regularly used packages and maybe some helper functions in a separate script and then load this script with `source(...)` into the Global Environment. 

However, this approach has two disadvantages:

1. Over time, the Global Environment becomes littered, making it harder to find important objects and

1. The `source` script must either be available and up-to-date on the local machine or be made available on the Internet.

## Package Purpose

The best solution for the above mentioned disadvantages is an own (personal) package, but for the setup it needs a basic understanding of how to develop packages.

The goal of personalr is to do exactly that. A basic setup of a personal package, which loads a modifiable list of packages and some basic functions.

## Installation

You can install the released version of personalr from [CRAN](https://cran.r-project.org/package=personalr) with:

``` {r eval = FALSE}

install.packages("personalr")

```

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

``` {r eval = FALSE}

if (!require("pak")) install.packages("pak")

pak::pak("mrcaseb/personalr")

```

## One more thing

personalr is open source and it builds on top of other open source projects. However, maintaining this package will be a lot of work so I kindly ask you to consider donating at [patreon](https://www.patreon.com/mrcaseb).