Giter Club home page Giter Club logo

zonator's Introduction

Project Status: Active - The project has reached a stable, usable state and is being actively developed. GitHub version Build Status AppVeyor Build Status codecov

zonator

zonator is a utility R package for dealing with various tasks related to Zonation conservation prioritization software. The package started out as a collection of helper scripts which have now been packaged for anybody interested in using a familiar tool (R) in setting up Zonation runs and managing Zonation results.

Functions and classes found in zonator can be useful for the following stages of running a Zonation analysis.

  1. Setting up a Zonation project and pre-processing files (examples).
  2. Running Zonation.
  3. Post-processing, results analysis and comparison, and plotting (examples).

Installation

Release version

You can install the latest release version from CRAN:

install.packages("zonator")

Development version

Alternatively, you can install the latest (potentially unstable) development version from Github.

  1. Make sure you have package remotes installed and loaded in R:
# Open R prompt or RStudio and type the following on the command line
install.packages("remotes")
  1. Then install zonator directly from GitHub by running the following line in R:
remotes::install_github("cbig/zonator", ref = "develop", build_vignettes = TRUE)

Examples

Some examples are provided by the package vignettes. You can view these after installing the package by:

vignette("zonator-project")

and

vignette("zonator-results")

Developers

zonator's People

Contributors

elgabbas avatar jlehtoma avatar salim-b avatar tuulit avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

zonator's Issues

Refactor dependencies

So far more-or-less necessary packages are all in depends in DESCRIPTION file. See if some of these could be moved to imports or suggests.

Make performance curve plotting more intelligent

If there are many features / groups to plot in performance curves, the graphical resolution of the plot may not be good. Plot generic should inspect how many lines need to be plotted and adjust the linetype/color mappings accordingly.

Group naming does not work if group IDs change

Group IDs vector can be changed:

groups(variant) <- something

but trying to add new names mapping does not work as the number of categories is still being checked against the original groups-file.

Subsetting groups in curves()

Using argument cols while groups=TRUE in curves() does not work. Either warn user about this or implement correct group subsetting.

Refactor performance curves plotting code

Both plot_curves and plot_grp_curves should have only 1 plotting function. Preprocessing the data (read in and parse) should be done separately (still within 1 function?).

Implement logging when reading in Zproject

When Zproject is being created based on existing project, a lot of files are being read in. Implement debug logging to track which files are read in in case something goes wrong.

User defined paths to create_zproject

Create_zproject would benefit from a feature where user could define different paths to be used in .bat files. Now root.path is used automatically which is awkward if one wants to use relative paths.

Feature names get lost

Feature names works ok for variants but get lost when analyzing results (e.g. the plots use only f1, f2, f3, etc. and featurenames(results) return this:
[1] "f1" "f2" "f3" "f4"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.