pfusetup

https://github.com/energyeconomydecoupling/pfusetup

Repository

README.Rmd

---
output: github_document
---



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




[![CRAN status](https://www.r-pkg.org/badges/version/Recca)](https://cran.r-project.org/package=PFUSetup)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R-CMD-check](https://github.com/EnergyEconomyDecoupling/PFUSetup/workflows/R-CMD-check/badge.svg)](https://github.com/EnergyEconomyDecoupling/PFUSetup/actions)
[![Codecov test coverage](https://codecov.io/gh/EnergyEconomyDecoupling/PFUSetup/branch/master/graph/badge.svg)](https://codecov.io/gh/EnergyEconomyDecoupling/PFUSetup?branch=master)
[![DOI](https://zenodo.org/badge/289910348.svg)](https://zenodo.org/badge/latestdoi/289910348)
[![R-CMD-check](https://github.com/EnergyEconomyDecoupling/PFUSetup/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/EnergyEconomyDecoupling/PFUSetup/actions/workflows/R-CMD-check.yaml)



# PFUSetup


## Statement of need

Several packages are involved in creating the CL-PFU database.
Each of those packages needs access to directories and files
on a variety of machines. 
A way to organize and standardize those directory and file 
paths was needed. 

This package (`PFUSetup`) addresses that need.
`PFUSetup` automates the setup process for the CL-PFU database
by finding the locations of several directories
common to all installations of the CL-PFU database 
in a platform- and machine-independent manner.


## Installation

You can install the latest version of `PFUSetup` from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("EnergyEconomyDecoupling/PFUSetup")
```


## Example

You might use the package as follows:

``` r
library(PFUSetup)
get_abs_paths()
```


## More Information

Find more information, including vignettes and function documentation, at 
.

Owner

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: PFUSetup
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Matthew
    family-names: Heun
    email: matthew.heun@me.com
    affiliation: Calvin University
    orcid: 'https://orcid.org/0000-0002-7438-214X'
identifiers:
  - type: doi
    value: 10.5281/zenodo.5228359
    description: DOI for all versions of the package
repository-code: 'https://github.com/EnergyEconomyDecoupling/PFUSetup'
url: 'https://energyeconomydecoupling.github.io/PFUSetup/'
abstract: >-
  In the context of the broader CL-PFU database,
  the PFUSetup package provides information on input files
  and results common to all machines running
  the CL-PFU database code.
license: MIT

GitHub Events