README.md

In bogdanoancea/simutils: Basic functionalities to deal with simulated mobile network data

simutils

How to finish setting up your new package

Now that you've got a working package skeleton, there are a few steps to finish setting up all the integrations:

Git(Hub)

Go to https://github.com/yourgithub and create a new repository. Then, in the directory where this package is, create your git repository from the command line, add the files, and push it to GitHub:

git init
git add --all
git commit -m "Initial commit of package skeleton"
git remote add origin [e-mail]:yourgithub/simutils.git
git push -u origin master

Installing

The pre-release version of the package can be pulled from GitHub using the devtools package:

# install.packages("devtools")
devtools::install_github("yourgithub/simutils", build_vignettes=TRUE)

For developers

The repository includes a Makefile to facilitate some common tasks.

Running tests

$ make test. Requires the testthat package. You can also specify a specific test file or files to run by adding a "file=" argument, like $ make test file=logging. test_package will do a regular-expression pattern match within the file names. See its documentation in the testthat package.

Updating documentation

$ make doc. Requires the roxygen2 package.

bogdanoancea/simutils documentation built on April 4, 2022, 2:58 p.m.