Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve epi df doc #103

Merged
merged 6 commits into from
Jul 7, 2022
Merged

improve epi df doc #103

merged 6 commits into from
Jul 7, 2022

Conversation

ChloeYou
Copy link
Contributor

@ChloeYou ChloeYou commented Jun 14, 2022

Closes #93.

One example file was created and stored in man/rmd/epi-df-example.Rmd. The file was referred to in the main epiprocess vignette and also in the as_epi_df() example section.

#' @includeRmd man/rmd/<some-name>.Rmd examples throws errors so the examples are added to the main vignette and the roxygen separately. The documentation states:

It is currently not possible to document function arguments, return values, etc. in external Rmd documents.

R/epi_df.R Outdated Show resolved Hide resolved
R/epi_df.R Outdated Show resolved Hide resolved
R/epi_df.R Outdated Show resolved Hide resolved
R/epi_df.R Outdated Show resolved Hide resolved
R/epi_df.R Outdated Show resolved Hide resolved
R/epi_df.R Outdated Show resolved Hide resolved
R/epi_df.R Outdated Show resolved Hide resolved
Copy link
Contributor

@brookslogan brookslogan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice examples! We may want to borrow these when constructing any tests for behavior regarding other_keys. I have a some minor comments/requests + we should check on / copy over the appropriate data attribution to this vignette + a couple things that should be filed as separate issues if not addressed here.

@ChloeYou ChloeYou requested a review from brookslogan July 4, 2022 18:39
@ChloeYou
Copy link
Contributor Author

ChloeYou commented Jul 5, 2022

@brookslogan I think I've addressed all the comments. Let me know if anything else should be changed, otherwise we can probably merge this? Thanks!

@brookslogan brookslogan merged commit c7749c8 into main Jul 7, 2022
@dshemetov dshemetov deleted the cyou/improve-epi-df-doc branch November 15, 2023 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improved docs for as_epi_df()
3 participants