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

Allow specification of report title? #103

Closed
langfob opened this issue Feb 21, 2019 · 2 comments
Closed

Allow specification of report title? #103

langfob opened this issue Feb 21, 2019 · 2 comments

Comments

@langfob
Copy link

@langfob langfob commented Feb 21, 2019

Would it be useful and easy to allow the user to specify their own report title in the call to create_report?

I often have several analyses open at once but they all have the same title: "Data Profiling Report", which makes it harder to figure out which one I'm looking at.

Currently, the title seems to be hard-coded in rmd_template/report.rmd. I know that in an Rmd file I could print a variable title by saying:

params:
  mytitle: "whatever my title is"
title: "`r params$mytitle`"

So, could you

  • add a title argument to create_report that defaults to "Data Profiling Report",
  • pass the title variable in the params list that is handed to the render call inside create_report,
  • modify the title command in the report.rmd file?

That seems straightforward, but I'm also not expert enough to know if that would create some kind of security risk because R would be executing params$mytitle.

In any case thanks a lot for creating this package. It's very useful.

@boxuancui boxuancui self-assigned this Feb 22, 2019
@boxuancui boxuancui added this to the v0.8.0 milestone Feb 22, 2019
boxuancui added a commit that referenced this issue Mar 13, 2019
@boxuancui
Copy link
Owner

@boxuancui boxuancui commented Mar 13, 2019

@langfob This is now available using create_report(..., report_title = "My Fancy Report").

@boxuancui boxuancui closed this Mar 13, 2019
@langfob
Copy link
Author

@langfob langfob commented Mar 13, 2019

@boxuancui Great. I couldn't find this option in any of the source code or the documentation or your wiki articles or the documentation for render. It's exactly what I needed. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.