{"action":"created","comment":{"url":"https://api.github.com/repos/indigobio/elm-plot/pulls/comments/59555171","id":59555171,"diff_hunk":"@@ -0,0 +1,79 @@\n+# elm-plots\n+elm-plots is a plotting framework built entirely in elm using svgs. It draws inspiration from [d3](https://github.com/mbostock/d3) and [vega](https://github.com/vega/vega). Its goal is to make drawing visuals such as plots and charts easy to do. \n+\n+## Plots\n+A plot consists of top level attributes, scales, and visual elements. To make it easy to build up a plot, its functions are setup in a way to chain together updating and adding to it using the [forward function applicator](http://package.elm-lang.org/packages/elm-lang/core/3.0.0/Basics#|). For example a bar chart with vertical bars without axes can be created with the following elm code: \n+\n+```elm\n+import Svg exposing (Svg)\n+import Plot exposing (..)\n+import Plot.Scale as Scale\n+\n+main : Svg\n+main =\n+  let\n+    xScale = Scale.ordinalBands [\"a\", \"b\", \"c\", \"d\"] (0, 800) 0 0\n+    yScale = Scale.linear (0, 400) (800, 0) 0\n+  in\n+    createPlot 800 800\n+      |> addVerticalBars points .x .y xScale yScale []\n+      |> toSvg\n+\n+points : List { x : String, y : Float }\n+points =\n+  [ {x = \"a\", y = 10}\n+  , {x = \"b\", y = 50}\n+  , {x = \"c\", y = 100}\n+  , {x = \"d\", y = 400}\n+  , {x = \"e\", y = 150}\n+  ]\n+```\n+\n+### Top level attributes\n+Top level attributes include things like dimensions, margins, title, etc. The only information that is needed to initially create a plot is its dimensions. The rest have defaults that can be overridden as needed.\n+\n+### Scales\n+Scales tell how to position your visual elements in a plot. All scales are given an input (domain) and an output (range). The domain is dependent on the type of scale. The range is the range in pixels that you would like your inputs mapped to. Scales are also in charge of creating the locations for ticks for an axis. This is because the tick placement for an axis is dependent on the given scale. Information needed creating ticks varies from scale to scale. As an example, a linear scale can be created with the following: ","path":"Readme.md","position":36,"original_position":36,"commit_id":"7fb31610ccce0a12417fa70f1529764d23365f4c","original_commit_id":"7fb31610ccce0a12417fa70f1529764d23365f4c","user":{"login":"codyplungis","id":1347938,"avatar_url":"https://avatars.githubusercontent.com/u/1347938?v=3","gravatar_id":"","url":"https://api.github.com/users/codyplungis","html_url":"https://github.com/codyplungis","followers_url":"https://api.github.com/users/codyplungis/followers","following_url":"https://api.github.com/users/codyplungis/following{/other_user}","gists_url":"https://api.github.com/users/codyplungis/gists{/gist_id}","starred_url":"https://api.github.com/users/codyplungis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/codyplungis/subscriptions","organizations_url":"https://api.github.com/users/codyplungis/orgs","repos_url":"https://api.github.com/users/codyplungis/repos","events_url":"https://api.github.com/users/codyplungis/events{/privacy}","received_events_url":"https://api.github.com/users/codyplungis/received_events","type":"User","site_admin":false},"body":"Replace \"tell\" with something else. My best suggestion is \"determine\"\r\n\"All scales are given an...\" -> \"All scales are created with an...\"\r\n\"The domain is dependent on the type of scale.\" That's great, but elaborate a bit. I would recommend differentiating between ordinal and numerical scales.","created_at":"2016-04-13T14:15:36Z","updated_at":"2016-04-13T14:15:36Z","html_url":"https://github.com/indigobio/elm-plot/pull/2#discussion_r59555171","pull_request_url":"https://api.github.com/repos/indigobio/elm-plot/pulls/2","_links":{"self":{"href":"https://api.github.com/repos/indigobio/elm-plot/pulls/comments/59555171"},"html":{"href":"https://github.com/indigobio/elm-plot/pull/2#discussion_r59555171"},"pull_request":{"href":"https://api.github.com/repos/indigobio/elm-plot/pulls/2"}}},"pull_request":{"url":"https://api.github.com/repos/indigobio/elm-plot/pulls/2","id":66176145,"html_url":"https://github.com/indigobio/elm-plot/pull/2","diff_url":"https://github.com/indigobio/elm-plot/pull/2.diff","patch_url":"https://github.com/indigobio/elm-plot/pull/2.patch","issue_url":"https://api.github.com/repos/indigobio/elm-plot/issues/2","number":2,"state":"open","locked":false,"title":"Created everyting for bar charts including, initial plot interface, l…","user":{"login":"oakesja","id":2292766,"avatar_url":"https://avatars.githubusercontent.com/u/2292766?v=3","gravatar_id":"","url":"https://api.github.com/users/oakesja","html_url":"https://github.com/oakesja","followers_url":"https://api.github.com/users/oakesja/followers","following_url":"https://api.github.com/users/oakesja/following{/other_user}","gists_url":"https://api.github.com/users/oakesja/gists{/gist_id}","starred_url":"https://api.github.com/users/oakesja/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oakesja/subscriptions","organizations_url":"https://api.github.com/users/oakesja/orgs","repos_url":"https://api.github.com/users/oakesja/repos","events_url":"https://api.github.com/users/oakesja/events{/privacy}","received_events_url":"https://api.github.com/users/oakesja/received_events","type":"User","site_admin":false},"body":"…inear and ordinal band scales, and bars\r\n\r\nSee readme for documentation on what all is added. \r\n\r\nAfter this PR another for getting this ready to be a package which will include \r\n\r\n- getting elm-package.json in the right state\r\n- adding appropriate documentation in code for this to be a package","created_at":"2016-04-12T15:18:14Z","updated_at":"2016-04-13T14:15:36Z","closed_at":null,"merged_at":null,"merge_commit_sha":"650ba504cf5fbbf0c0d45074da0adb22a993b039","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/indigobio/elm-plot/pulls/2/commits","review_comments_url":"https://api.github.com/repos/indigobio/elm-plot/pulls/2/comments","review_comment_url":"https://api.github.com/repos/indigobio/elm-plot/pulls/comments{/number}","comments_url":"https://api.github.com/repos/indigobio/elm-plot/issues/2/comments","statuses_url":"https://api.github.com/repos/indigobio/elm-plot/statuses/7fb31610ccce0a12417fa70f1529764d23365f4c","head":{"label":"indigobio:f-barChart","ref":"f-barChart","sha":"7fb31610ccce0a12417fa70f1529764d23365f4c","user":{"login":"indigobio","id":711805,"avatar_url":"https://avatars.githubusercontent.com/u/711805?v=3","gravatar_id":"","url":"https://api.github.com/users/indigobio","html_url":"https://github.com/indigobio","followers_url":"https://api.github.com/users/indigobio/followers","following_url":"https://api.github.com/users/indigobio/following{/other_user}","gists_url":"https://api.github.com/users/indigobio/gists{/gist_id}","starred_url":"https://api.github.com/users/indigobio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/indigobio/subscriptions","organizations_url":"https://api.github.com/users/indigobio/orgs","repos_url":"https://api.github.com/users/indigobio/repos","events_url":"https://api.github.com/users/indigobio/events{/privacy}","received_events_url":"https://api.github.com/users/indigobio/received_events","type":"Organization","site_admin":false},"repo":{"id":55440731,"name":"elm-plot","full_name":"indigobio/elm-plot","owner":{"login":"indigobio","id":711805,"avatar_url":"https://avatars.githubusercontent.com/u/711805?v=3","gravatar_id":"","url":"https://api.github.com/users/indigobio","html_url":"https://github.com/indigobio","followers_url":"https://api.github.com/users/indigobio/followers","following_url":"https://api.github.com/users/indigobio/following{/other_user}","gists_url":"https://api.github.com/users/indigobio/gists{/gist_id}","starred_url":"https://api.github.com/users/indigobio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/indigobio/subscriptions","organizations_url":"https://api.github.com/users/indigobio/orgs","repos_url":"https://api.github.com/users/indigobio/repos","events_url":"https://api.github.com/users/indigobio/events{/privacy}","received_events_url":"https://api.github.com/users/indigobio/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/indigobio/elm-plot","description":"Plotting utils for elm","fork":true,"url":"https://api.github.com/repos/indigobio/elm-plot","forks_url":"https://api.github.com/repos/indigobio/elm-plot/forks","keys_url":"https://api.github.com/repos/indigobio/elm-plot/keys{/key_id}","collaborators_url":"https://api.github.com/repos/indigobio/elm-plot/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/indigobio/elm-plot/teams","hooks_url":"https://api.github.com/repos/indigobio/elm-plot/hooks","issue_events_url":"https://api.github.com/repos/indigobio/elm-plot/issues/events{/number}","events_url":"https://api.github.com/repos/indigobio/elm-plot/events","assignees_url":"https://api.github.com/repos/indigobio/elm-plot/assignees{/user}","branches_url":"https://api.github.com/repos/indigobio/elm-plot/branches{/branch}","tags_url":"https://api.github.com/repos/indigobio/elm-plot/tags","blobs_url":"https://api.github.com/repos/indigobio/elm-plot/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/indigobio/elm-plot/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/indigobio/elm-plot/git/refs{/sha}","trees_url":"https://api.github.com/repos/indigobio/elm-plot/git/trees{/sha}","statuses_url":"https://api.github.com/repos/indigobio/elm-plot/statuses/{sha}","languages_url":"https://api.github.com/repos/indigobio/elm-plot/languages","stargazers_url":"https://api.github.com/repos/indigobio/elm-plot/stargazers","contributors_url":"https://api.github.com/repos/indigobio/elm-plot/contributors","subscribers_url":"https://api.github.com/repos/indigobio/elm-plot/subscribers","subscription_url":"https://api.github.com/repos/indigobio/elm-plot/subscription","commits_url":"https://api.github.com/repos/indigobio/elm-plot/commits{/sha}","git_commits_url":"https://api.github.com/repos/indigobio/elm-plot/git/commits{/sha}","comments_url":"https://api.github.com/repos/indigobio/elm-plot/comments{/number}","issue_comment_url":"https://api.github.com/repos/indigobio/elm-plot/issues/comments{/number}","contents_url":"https://api.github.com/repos/indigobio/elm-plot/contents/{+path}","compare_url":"https://api.github.com/repos/indigobio/elm-plot/compare/{base}...{head}","merges_url":"https://api.github.com/repos/indigobio/elm-plot/merges","archive_url":"https://api.github.com/repos/indigobio/elm-plot/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/indigobio/elm-plot/downloads","issues_url":"https://api.github.com/repos/indigobio/elm-plot/issues{/number}","pulls_url":"https://api.github.com/repos/indigobio/elm-plot/pulls{/number}","milestones_url":"https://api.github.com/repos/indigobio/elm-plot/milestones{/number}","notifications_url":"https://api.github.com/repos/indigobio/elm-plot/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/indigobio/elm-plot/labels{/name}","releases_url":"https://api.github.com/repos/indigobio/elm-plot/releases{/id}","deployments_url":"https://api.github.com/repos/indigobio/elm-plot/deployments","created_at":"2016-04-04T20:01:16Z","updated_at":"2016-04-04T20:13:19Z","pushed_at":"2016-04-12T15:18:14Z","git_url":"git://github.com/indigobio/elm-plot.git","ssh_url":"git@github.com:indigobio/elm-plot.git","clone_url":"https://github.com/indigobio/elm-plot.git","svn_url":"https://github.com/indigobio/elm-plot","homepage":null,"size":179,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":1,"forks":0,"open_issues":1,"watchers":0,"default_branch":"master"}},"base":{"label":"indigobio:master","ref":"master","sha":"e7fd3b72f114dbe940ed58a3de9ea086e1a4d8b2","user":{"login":"indigobio","id":711805,"avatar_url":"https://avatars.githubusercontent.com/u/711805?v=3","gravatar_id":"","url":"https://api.github.com/users/indigobio","html_url":"https://github.com/indigobio","followers_url":"https://api.github.com/users/indigobio/followers","following_url":"https://api.github.com/users/indigobio/following{/other_user}","gists_url":"https://api.github.com/users/indigobio/gists{/gist_id}","starred_url":"https://api.github.com/users/indigobio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/indigobio/subscriptions","organizations_url":"https://api.github.com/users/indigobio/orgs","repos_url":"https://api.github.com/users/indigobio/repos","events_url":"https://api.github.com/users/indigobio/events{/privacy}","received_events_url":"https://api.github.com/users/indigobio/received_events","type":"Organization","site_admin":false},"repo":{"id":55440731,"name":"elm-plot","full_name":"indigobio/elm-plot","owner":{"login":"indigobio","id":711805,"avatar_url":"https://avatars.githubusercontent.com/u/711805?v=3","gravatar_id":"","url":"https://api.github.com/users/indigobio","html_url":"https://github.com/indigobio","followers_url":"https://api.github.com/users/indigobio/followers","following_url":"https://api.github.com/users/indigobio/following{/other_user}","gists_url":"https://api.github.com/users/indigobio/gists{/gist_id}","starred_url":"https://api.github.com/users/indigobio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/indigobio/subscriptions","organizations_url":"https://api.github.com/users/indigobio/orgs","repos_url":"https://api.github.com/users/indigobio/repos","events_url":"https://api.github.com/users/indigobio/events{/privacy}","received_events_url":"https://api.github.com/users/indigobio/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/indigobio/elm-plot","description":"Plotting utils for elm","fork":true,"url":"https://api.github.com/repos/indigobio/elm-plot","forks_url":"https://api.github.com/repos/indigobio/elm-plot/forks","keys_url":"https://api.github.com/repos/indigobio/elm-plot/keys{/key_id}","collaborators_url":"https://api.github.com/repos/indigobio/elm-plot/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/indigobio/elm-plot/teams","hooks_url":"https://api.github.com/repos/indigobio/elm-plot/hooks","issue_events_url":"https://api.github.com/repos/indigobio/elm-plot/issues/events{/number}","events_url":"https://api.github.com/repos/indigobio/elm-plot/events","assignees_url":"https://api.github.com/repos/indigobio/elm-plot/assignees{/user}","branches_url":"https://api.github.com/repos/indigobio/elm-plot/branches{/branch}","tags_url":"https://api.github.com/repos/indigobio/elm-plot/tags","blobs_url":"https://api.github.com/repos/indigobio/elm-plot/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/indigobio/elm-plot/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/indigobio/elm-plot/git/refs{/sha}","trees_url":"https://api.github.com/repos/indigobio/elm-plot/git/trees{/sha}","statuses_url":"https://api.github.com/repos/indigobio/elm-plot/statuses/{sha}","languages_url":"https://api.github.com/repos/indigobio/elm-plot/languages","stargazers_url":"https://api.github.com/repos/indigobio/elm-plot/stargazers","contributors_url":"https://api.github.com/repos/indigobio/elm-plot/contributors","subscribers_url":"https://api.github.com/repos/indigobio/elm-plot/subscribers","subscription_url":"https://api.github.com/repos/indigobio/elm-plot/subscription","commits_url":"https://api.github.com/repos/indigobio/elm-plot/commits{/sha}","git_commits_url":"https://api.github.com/repos/indigobio/elm-plot/git/commits{/sha}","comments_url":"https://api.github.com/repos/indigobio/elm-plot/comments{/number}","issue_comment_url":"https://api.github.com/repos/indigobio/elm-plot/issues/comments{/number}","contents_url":"https://api.github.com/repos/indigobio/elm-plot/contents/{+path}","compare_url":"https://api.github.com/repos/indigobio/elm-plot/compare/{base}...{head}","merges_url":"https://api.github.com/repos/indigobio/elm-plot/merges","archive_url":"https://api.github.com/repos/indigobio/elm-plot/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/indigobio/elm-plot/downloads","issues_url":"https://api.github.com/repos/indigobio/elm-plot/issues{/number}","pulls_url":"https://api.github.com/repos/indigobio/elm-plot/pulls{/number}","milestones_url":"https://api.github.com/repos/indigobio/elm-plot/milestones{/number}","notifications_url":"https://api.github.com/repos/indigobio/elm-plot/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/indigobio/elm-plot/labels{/name}","releases_url":"https://api.github.com/repos/indigobio/elm-plot/releases{/id}","deployments_url":"https://api.github.com/repos/indigobio/elm-plot/deployments","created_at":"2016-04-04T20:01:16Z","updated_at":"2016-04-04T20:13:19Z","pushed_at":"2016-04-12T15:18:14Z","git_url":"git://github.com/indigobio/elm-plot.git","ssh_url":"git@github.com:indigobio/elm-plot.git","clone_url":"https://github.com/indigobio/elm-plot.git","svn_url":"https://github.com/indigobio/elm-plot","homepage":null,"size":179,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":1,"forks":0,"open_issues":1,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/indigobio/elm-plot/pulls/2"},"html":{"href":"https://github.com/indigobio/elm-plot/pull/2"},"issue":{"href":"https://api.github.com/repos/indigobio/elm-plot/issues/2"},"comments":{"href":"https://api.github.com/repos/indigobio/elm-plot/issues/2/comments"},"review_comments":{"href":"https://api.github.com/repos/indigobio/elm-plot/pulls/2/comments"},"review_comment":{"href":"https://api.github.com/repos/indigobio/elm-plot/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/indigobio/elm-plot/pulls/2/commits"},"statuses":{"href":"https://api.github.com/repos/indigobio/elm-plot/statuses/7fb31610ccce0a12417fa70f1529764d23365f4c"}}}}