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

Typhoid vignette #21

Closed
wants to merge 22 commits into from
Closed

Typhoid vignette #21

wants to merge 22 commits into from

Conversation

kristinawlai
Copy link
Collaborator

I finished the typhoid vignette withe the simulated data and moved the references.bib to the vignettes folder. However, Kristen recommended using the South Sudan data for this vignette so it's real data. The simulated data doesn't have age groups, so it's just overall incidence. I can make those updates, but wanted to get this version pushed out first to have something. Would it be useful to have an overall vignette and an age-specific vignette? Or perhaps include both in the same vignette?

@kristinawlai
Copy link
Collaborator Author

@d-morrison Uh oh checks are failing now. Did I use an older version before your fixes?

@d-morrison
Copy link
Member

@d-morrison Uh oh checks are failing now. Did I use an older version before your fixes?

@kristinawlai:

The relevant error is:

could not find function "load_all"

The load_all function is only for in-development code. The finalized vignettes should use library(serocalculator) instead. Try making that change; to test on your local computer, first run the install() command in the Console, then replace load_all() with library(serocalculator), then run the test() command in the Console. If the output of test() is all tests passed, then the tests on github should also pass.

Copy link
Member

@d-morrison d-morrison left a comment

Choose a reason for hiding this comment

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

(see my reply re: check errors)

@kristinawlai
Copy link
Collaborator Author

@d-morrison I removed load_all() and devtools() from typhoid-seroincidence.rmd and tutorial.rmd, but there are still errors. When I use test() in my console there are no errors either, but it has been running so quickly that I don't trust it. Any tips?

@d-morrison
Copy link
Member

d-morrison commented Nov 3, 2023

@d-morrison I removed load_all() and devtools() from typhoid-seroincidence.rmd and tutorial.rmd, but there are still errors. When I use test() in my console there are no errors either, but it has been running so quickly that I don't trust it. Any tips?

@kristinawlai Looks like there is a reference to the "seroincidence" package somewhere: in the checks, there is a message:

Error: Error: processing vignette 'tutorial.Rmd' failed with diagnostics:
4 nodes produced errors; first error: there is no package called ‘seroincidence’
```

@kristinawlai
Copy link
Collaborator Author

@d-morrison the checks pass now! This is the only warning I saw when checking on my desktop and I'm not quite sure what to do with it. Maybe just a function name issue?

W checking for code/documentation mismatches (1.8s)
Functions or methods with usage in documentation object 'incidence.age' but not in code:
'incidence.age'

@kristinawlai
Copy link
Collaborator Author

Closing this since all updates were moved to the typhoid_vignette_hack branch

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.

2 participants