https://github.com/andyclifton/pcwg-share-01

Code to analyse data from the PCWG_Share_01 Exercise
https://github.com/andyclifton/pcwg-share-01

Last synced: 9 days ago
JSON representation

Code to analyse data from the PCWG_Share_01 Exercise

• Host: GitHub
• URL: https://github.com/andyclifton/pcwg-share-01
• Owner: AndyClifton
• Created: 2015-11-30T17:20:10.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-02T14:50:39.000Z (over 7 years ago)
• Last Synced: 2024-11-15T16:48:24.163Z (2 months ago)
• Language: R
• Size: 6.03 MB
• Stars: 0
• Watchers: 5
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Introduction

This is the repository for an R package that provides code to aggregate responses to the Power Curve Working Group "PCWG_Share_01" exercise. More details of the exercise can be found at http://www.pcwg.org and http://www.pcwg.org/PCWG-Share-01/PCWG-Share-01-Definition-Document.pdf.

# Requirements

1. A working installation of R with up-to-date packages. This can be obtained from e.g. http://r-project.org.

   1. `ggplot2` version 2.2 or higher [is required to generate titles, captions, and other annotations on figures](http://ggplot2.tidyverse.org/reference/labs.html).

2. A GUI for R. [R-studio is a popular option](http://rstudio.com).

3. Two or more data files from the Power Curve Working Group Tool, prepared for PCWG_Share_01

# Releases

You can find the most recent _stable_ version of this code in the [releases](../../releases) part of this repository. These different versions are designed to work with different versions of the PCWG Share Tool. You can download the source there.

# How To Use This Code

1. Create a directory somewhere and place the contents of the zip file into that directory (let's call this `$root`). *It is recommended that there be nothing else in the directory*.

2. Load the PWCG tool data files into a 'data' directory in `$root`. You can add directories for different sites, etc.

3. Open `PCWG_share_01_main.rmd` in Rstudio. 

  1. Modify `project.root` to be `$root`.

  2. Decide if you intend the results to be public. If you do, set `data.public` to `TRUE`. This will prevent any details of the individual data sets being shown. If `data.public` is `FALSE`, all results will be printed.

  3. Decide if you want to reanalyze raw data and set `data.analyze.raw`. This should be `TRUE` the first time you run the code. Afterwards you can set this to `FALSE` to just generate plots.

4. Run `PCWG_share_01_main.rmd` in Rstudio. Either:

  1. hit `chunks -> run all` to run all of the R code and not generate any output PDF or HTML files.

  2. hit `knit HTML` to generate the html results file; this will create an HTML file but will not generate any data in memory

  3. hit `knit PDF` to generate the html results file; this will create an HTML file but will not generate any data in memory

# Documentation

Documentation is provided in several forms:

* within `PCWG_share_01_main.rmd`

* within `PCWG_share_01_main.pdf`, which will also contain the results when run using `knitr`.

* within `PCWG_share_01_main.html`, which will also contain the results when run using `knitr`.

# Reporting Bugs and Requesting Improvements

Please use the [issue tracker](../../issues) to report problems or request improvements.

# Wiki

Please use [the wiki](../../wiki) in this repository as you feel fit.

# Comments

This software is provided as is, with no guarantees.

# Recent changes

See /releases.

# Code Maintainers

* [Andy Clifton](mailto:[email protected]) WindForS Wind Energy Research Cluster

# Project Contributors

* Peter Stuart, RES