{"action":"created","issue":{"url":"https://api.github.com/repos/DeclareDesign/DeclareDesign/issues/132","repository_url":"https://api.github.com/repos/DeclareDesign/DeclareDesign","labels_url":"https://api.github.com/repos/DeclareDesign/DeclareDesign/issues/132/labels{/name}","comments_url":"https://api.github.com/repos/DeclareDesign/DeclareDesign/issues/132/comments","events_url":"https://api.github.com/repos/DeclareDesign/DeclareDesign/issues/132/events","html_url":"https://github.com/DeclareDesign/DeclareDesign/issues/132","id":172557209,"number":132,"title":"start a vignette on summarizing custom functions","user":{"login":"jaspercooper","id":6787409,"avatar_url":"https://avatars.githubusercontent.com/u/6787409?v=3","gravatar_id":"","url":"https://api.github.com/users/jaspercooper","html_url":"https://github.com/jaspercooper","followers_url":"https://api.github.com/users/jaspercooper/followers","following_url":"https://api.github.com/users/jaspercooper/following{/other_user}","gists_url":"https://api.github.com/users/jaspercooper/gists{/gist_id}","starred_url":"https://api.github.com/users/jaspercooper/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jaspercooper/subscriptions","organizations_url":"https://api.github.com/users/jaspercooper/orgs","repos_url":"https://api.github.com/users/jaspercooper/repos","events_url":"https://api.github.com/users/jaspercooper/events{/privacy}","received_events_url":"https://api.github.com/users/jaspercooper/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2016-08-22T21:17:00Z","updated_at":"2016-08-24T02:44:04Z","closed_at":null,"body":"Idea is to set up different custom functions and see how well we can do in terms of summarizing them so that summaries are informative when users employ custom functions"},"comment":{"url":"https://api.github.com/repos/DeclareDesign/DeclareDesign/issues/comments/241942243","html_url":"https://github.com/DeclareDesign/DeclareDesign/issues/132#issuecomment-241942243","issue_url":"https://api.github.com/repos/DeclareDesign/DeclareDesign/issues/132","id":241942243,"user":{"login":"gerasy1987","id":9358589,"avatar_url":"https://avatars.githubusercontent.com/u/9358589?v=3","gravatar_id":"","url":"https://api.github.com/users/gerasy1987","html_url":"https://github.com/gerasy1987","followers_url":"https://api.github.com/users/gerasy1987/followers","following_url":"https://api.github.com/users/gerasy1987/following{/other_user}","gists_url":"https://api.github.com/users/gerasy1987/gists{/gist_id}","starred_url":"https://api.github.com/users/gerasy1987/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gerasy1987/subscriptions","organizations_url":"https://api.github.com/users/gerasy1987/orgs","repos_url":"https://api.github.com/users/gerasy1987/repos","events_url":"https://api.github.com/users/gerasy1987/events{/privacy}","received_events_url":"https://api.github.com/users/gerasy1987/received_events","type":"User","site_admin":false},"created_at":"2016-08-24T02:44:04Z","updated_at":"2016-08-24T02:44:04Z","body":"I was envisioning smth like a wiki page explaining the structure of each declaration object (probably conditional on the type of declaration, e.g. with custom function or without it) and then explaining shortly what is held in each of the elements. For example for population objects I would start with smth like this:\r\n\r\n**population objects:**\r\n\r\n- `pop_object$population` -- function which draws population. In addition function environment holds:\r\n    - `environment(pop_object$population)$make_unique_ID` -- Logical. Whether to create unique IDs for each population observation\r\n    - `environment(pop_object$population)$options` -- List that holds all the additional options used for declaration of population passed via `options` argument in `declare_population` call\r\n    - `environment(pop_object$population)$global_transformations` -- ...\r\n    - `environment(pop_object$population)$level_IDs` -- vector of level IDs if they are supplied through `level_IDs` argument in `declare_population` call\r\n    - `environment(pop_object$population)$size` -- numeric vector of numbers of observation on each level\r\n    - `environment(pop_object$population)$expressions` -- list of lists each element of which corresponds to the level and contains as elements character calls which are used to create particular covariate by `pop_object$population()` function.\r\n\r\n- ..."}}
{"actor":{"display_login":"gerasy1987"}}