README.md

In jomuller/vartors: Transform Definition of Variables to R Scripts

This package is deprecated and unmainted due to of a lack of time of my part. Feel free to fork it.

vartors

vartors is an R package and an acronym for VARiable definition TO R Script skeleton. The idea is to describe explicitly the variables by defining their names, types, levels, labels and others caracteristics and then automaticaly produce R script following a template. It could help to import and clean up data from simple databases.

Installation

Stable version

You could install vartors from a CRAN repository with :

install.packages("vartors")

Or you can download it from GitHub if you have already the devtools :

devtools::install_github(repo="vartors", username ="jomuller", ref="master")

Development version

The development version can be installed from GitHub with the devtools by typing this line in R :

devtools::install_github(repo="vartors", username ="jomuller", ref="dev")

Install the devtools

If you don't have devtools installed, follow these steps :

1. If you are using Windows, you have to install the Rtools
2. Install the devtools package : install.packages("devtools")
3. Install the GitHub version of vartors as describe above

If you are behind a proxy you have to add the following lines before :

library(httr)
set_config( use_proxy(
    url = "proxy_url",    # Change with your proxy URL
    port = 8080,
    username = "user",    # Change with your login
    password = "password" # Change with your password
))

Usage

Read the documentation with ?vartors

The main functions are create_script, import_template, import_vardef and write_file. Helpers function are desvars_skeleton and export_template.

Participate

BugTracking

You are welcome to open issues on the issue page in GitHub.

Code, documentation

You are welcome to fork to improve the code and the documentation.

Release plan

Follow the milestones of this GitHub project to show the release plan.

Motivation

vartors was created to speed-up the boring and important importation to R phase in context of the methodology consultations. These methodology consultations are an important part of my daily work. The idea is to help physicians of my hospital to process their data and make great analysis. In our workflow, the physician must come with a database (mainly an Excel file), a description of the variables and a good question. For the moment, we spend too much time to clean up data and not enough to analyse it. That's where `vartors may help.

jomuller/vartors documentation built on May 19, 2019, 7:26 p.m.