Skip to content

Commit

Permalink
Fix pkgdown site 0.1.0.9004 (Novartis#30)
Browse files Browse the repository at this point in the history
* switch to Apache 2.0 + pkgdown fix
  • Loading branch information
m-l-1 authored Mar 3, 2020
1 parent 9ba6639 commit e4a86f5
Show file tree
Hide file tree
Showing 14 changed files with 276 additions and 49 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: tidymodules
Title: A robust framework for developing shiny modules
Version: 0.1.0.9004
Version: 0.1.0.9005
Authors@R: c(
person('Mustapha', 'Larbaoui', email = '[email protected]', role = c('cre', 'aut')),
person('Douglas', 'Robinson', email = '[email protected]', role = c('ctb')),
Expand All @@ -10,7 +10,7 @@ Authors@R: c(
person('Marzieh', 'Eslami Rasekh', email = '[email protected]', role = c('ctb')),
person('Renan', 'Sauteraud', email = '[email protected]', role = c('ctb')))
Description: tidymodules offers a robust framework for developing shiny modules based on R6 classes which should facilitates inter-modules communication.
License: MIT + file LICENSE
License: Apache License (>= 2.0)
Encoding: UTF-8
LazyData: true
Imports:
Expand Down
2 changes: 0 additions & 2 deletions LICENSE

This file was deleted.

191 changes: 170 additions & 21 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,170 @@
# MIT License

Copyright (c) 2019 Novartis AG

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Apache License
==============

_Version 2.0, January 2004_
_&lt;<http://www.apache.org/licenses/>&gt;_

### Terms and Conditions for use, reproduction, and distribution

#### 1. Definitions

“License” shall mean the terms and conditions for use, reproduction, and
distribution as defined by Sections 1 through 9 of this document.

“Licensor” shall mean the copyright owner or entity authorized by the copyright
owner that is granting the License.

“Legal Entity” shall mean the union of the acting entity and all other entities
that control, are controlled by, or are under common control with that entity.
For the purposes of this definition, “control” means **(i)** the power, direct or
indirect, to cause the direction or management of such entity, whether by
contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
outstanding shares, or **(iii)** beneficial ownership of such entity.

“You” (or “Your”) shall mean an individual or Legal Entity exercising
permissions granted by this License.

“Source” form shall mean the preferred form for making modifications, including
but not limited to software source code, documentation source, and configuration
files.

“Object” form shall mean any form resulting from mechanical transformation or
translation of a Source form, including but not limited to compiled object code,
generated documentation, and conversions to other media types.

“Work” shall mean the work of authorship, whether in Source or Object form, made
available under the License, as indicated by a copyright notice that is included
in or attached to the work (an example is provided in the Appendix below).

“Derivative Works” shall mean any work, whether in Source or Object form, that
is based on (or derived from) the Work and for which the editorial revisions,
annotations, elaborations, or other modifications represent, as a whole, an
original work of authorship. For the purposes of this License, Derivative Works
shall not include works that remain separable from, or merely link (or bind by
name) to the interfaces of, the Work and Derivative Works thereof.

“Contribution” shall mean any work of authorship, including the original version
of the Work and any modifications or additions to that Work or Derivative Works
thereof, that is intentionally submitted to Licensor for inclusion in the Work
by the copyright owner or by an individual or Legal Entity authorized to submit
on behalf of the copyright owner. For the purposes of this definition,
“submitted” means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems, and
issue tracking systems that are managed by, or on behalf of, the Licensor for
the purpose of discussing and improving the Work, but excluding communication
that is conspicuously marked or otherwise designated in writing by the copyright
owner as “Not a Contribution.”

“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
of whom a Contribution has been received by Licensor and subsequently
incorporated within the Work.

#### 2. Grant of Copyright License

Subject to the terms and conditions of this License, each Contributor hereby
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the Work and such
Derivative Works in Source or Object form.

#### 3. Grant of Patent License

Subject to the terms and conditions of this License, each Contributor hereby
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable (except as stated in this section) patent license to make, have
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
such license applies only to those patent claims licensable by such Contributor
that are necessarily infringed by their Contribution(s) alone or by combination
of their Contribution(s) with the Work to which such Contribution(s) was
submitted. If You institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
Contribution incorporated within the Work constitutes direct or contributory
patent infringement, then any patent licenses granted to You under this License
for that Work shall terminate as of the date such litigation is filed.

#### 4. Redistribution

You may reproduce and distribute copies of the Work or Derivative Works thereof
in any medium, with or without modifications, and in Source or Object form,
provided that You meet the following conditions:

* **(a)** You must give any other recipients of the Work or Derivative Works a copy of
this License; and
* **(b)** You must cause any modified files to carry prominent notices stating that You
changed the files; and
* **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
all copyright, patent, trademark, and attribution notices from the Source form
of the Work, excluding those notices that do not pertain to any part of the
Derivative Works; and
* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
Derivative Works that You distribute must include a readable copy of the
attribution notices contained within such NOTICE file, excluding those notices
that do not pertain to any part of the Derivative Works, in at least one of the
following places: within a NOTICE text file distributed as part of the
Derivative Works; within the Source form or documentation, if provided along
with the Derivative Works; or, within a display generated by the Derivative
Works, if and wherever such third-party notices normally appear. The contents of
the NOTICE file are for informational purposes only and do not modify the
License. You may add Your own attribution notices within Derivative Works that
You distribute, alongside or as an addendum to the NOTICE text from the Work,
provided that such additional attribution notices cannot be construed as
modifying the License.

You may add Your own copyright statement to Your modifications and may provide
additional or different license terms and conditions for use, reproduction, or
distribution of Your modifications, or for any such Derivative Works as a whole,
provided Your use, reproduction, and distribution of the Work otherwise complies
with the conditions stated in this License.

#### 5. Submission of Contributions

Unless You explicitly state otherwise, any Contribution intentionally submitted
for inclusion in the Work by You to the Licensor shall be under the terms and
conditions of this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify the terms of
any separate license agreement you may have executed with Licensor regarding
such Contributions.

#### 6. Trademarks

This License does not grant permission to use the trade names, trademarks,
service marks, or product names of the Licensor, except as required for
reasonable and customary use in describing the origin of the Work and
reproducing the content of the NOTICE file.

#### 7. Disclaimer of Warranty

Unless required by applicable law or agreed to in writing, Licensor provides the
Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
including, without limitation, any warranties or conditions of TITLE,
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
solely responsible for determining the appropriateness of using or
redistributing the Work and assume any risks associated with Your exercise of
permissions under this License.

#### 8. Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence),
contract, or otherwise, unless required by applicable law (such as deliberate
and grossly negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special, incidental,
or consequential damages of any character arising as a result of this License or
out of the use or inability to use the Work (including but not limited to
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
any and all other commercial damages or losses), even if such Contributor has
been advised of the possibility of such damages.

#### 9. Accepting Warranty or Additional Liability

While redistributing the Work or Derivative Works thereof, You may choose to
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
other liability obligations and/or rights consistent with this License. However,
in accepting such obligations, You may act only on Your own behalf and on Your
sole responsibility, not on behalf of any other Contributor, and only if You
agree to indemnify, defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason of your
accepting any such warranty or additional liability.

_END OF TERMS AND CONDITIONS_
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# tidymodules 0.1.0.9005

- switch to Apache-2.0 Licence


# tidymodules 0.1.0.9004

- add_module function
Expand Down
7 changes: 0 additions & 7 deletions R/tidymodules-package.R

This file was deleted.

19 changes: 19 additions & 0 deletions R/tidymodules.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Copyright 2020 Novartis AG
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#' @import shiny
#' @importFrom methods is
#'
#' @keywords internal
"_PACKAGE"
2 changes: 2 additions & 0 deletions R/utility.R
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,8 @@ getSessionId <- function(session = getDefaultReactiveDomain()){
#' @param r6cg A R6ClassGenerator object.
#'
#' @return vector of class names
#'
#' @keywords internal
get_R6CG_list <- function(r6cg){
if(!is(r6cg,"R6ClassGenerator"))
stop("provide a R6ClassGenerator object!")
Expand Down
20 changes: 18 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ htmltools::tagList(rmarkdown::html_dependency_font_awesome())
[![Travis-CI build status](https://travis-ci.org/Novartis/tidymodules.svg?branch=master)](https://travis-ci.org/Novartis/tidymodules)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

The `{tidymodules}` R package is built on top of shiny module using R6 to provide a new object-oriented programming (OOP) approach for module development, new module interface using input/output ports and a set of tidy operators for handling cross-module communication.
The `{tidymodules}` R package is built on top of shiny module using `{R6}` to provide a new object-oriented programming (OOP) approach for module development, new module interface using input/output ports and a set of tidy operators for handling cross-module communication.

The main features of tidymodules and its comparison with conventional Shiny modules are presented in the table below.

| Features | | tidymodules | Conventional modules |
|----|----------------------|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| [<i style="color:#285fa4;" class="fas fa-laptop-code fa-2x"></i>](articles/intro.html) | Programming style | - R6 OOP * <br/> - Semantic reference | Functional |
| [<i style="color:#285fa4;" class="fas fa-laptop-code fa-2x"></i>](articles/intro.html) | Programming style | - `{R6}` OOP * <br/> - Semantic reference | Functional |
| [<i style="color:#285fa4;" class="fas fa-th-large fa-2x"></i>](articles/namespace.html) | Namespace management | - automatic/generated <br/> - ID based lookup <br/> - Grouping | - manual management <br /> - must match between ui and server |
| [<i style="color:#285fa4;" class="fas fa-directions fa-2x"></i>](articles/communication.html) | Module communication | - new module input/output port structure <br/> - module ports linked via tidy operators <br/> - automatic network diagram | - parameter passing via module server() <br/> - challenging to manage for complex app |
| [<i style="color:#285fa4;" class="fas fa-sitemap fa-2x"></i>](articles/inheritance.html) | Inheritance | - class inheritance <br/> - port inheritance for nested modules | NA |
Expand Down Expand Up @@ -74,3 +74,19 @@ Please note that the `{tidymodules}` is released with a [Contributor Code of Con
- The SCC team members @ NVS for their valuable feedbacks
- 2019 Summer interns (Marzi, Stephen and Renan) for contributing to testing the framework and implementing the demo example 4 listed above.
- Eric Nantz for accepting to introduce tidymodules in his [e-poster](https://rpodcast.shinyapps.io/highlights-shiny) @ rstudio::conf 2020

## Licence

Copyright 2020 Novartis AG

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ tidymodules <img src="man/figures/logo.svg" align="right" height="139" />
status](https://travis-ci.org/Novartis/tidymodules.svg?branch=master)](https://travis-ci.org/Novartis/tidymodules)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

The `{tidymodules}` R package is built on top of shiny module using R6
to provide a new object-oriented programming (OOP) approach for module
development, new module interface using input/output ports and a set of
tidy operators for handling cross-module communication.
The `{tidymodules}` R package is built on top of shiny module using
`{R6}` to provide a new object-oriented programming (OOP) approach for
module development, new module interface using input/output ports and a
set of tidy operators for handling cross-module communication.

The main features of tidymodules and its comparison with conventional
Shiny modules are presented in the table below.
Expand All @@ -33,7 +33,7 @@ Shiny modules are presented in the table below.
<tr class="odd">
<td><a href="articles/intro.html"><i style="color:#285fa4;" class="fas fa-laptop-code fa-2x"></i></a></td>
<td>Programming style</td>
<td>- R6 OOP * <br/> - Semantic reference</td>
<td>- <code>{R6}</code> OOP * <br/> - Semantic reference</td>
<td>Functional</td>
</tr>
<tr class="even">
Expand Down Expand Up @@ -121,3 +121,20 @@ Acknowledgment
- Eric Nantz for accepting to introduce tidymodules in his
[e-poster](https://rpodcast.shinyapps.io/highlights-shiny) @
rstudio::conf 2020

Licence
-------

Copyright 2020 Novartis AG

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
1 change: 0 additions & 1 deletion inst/shiny/examples/3_nested_modules/DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Title: tidymodules - Nesting modules
Author: Mustapha Larbaoui
AuthorUrl: gitlab page
License: MIT
DisplayMode: Showcase
Tags: module, ggplot
Type: Shiny
1 change: 1 addition & 0 deletions man/get_R6CG_list.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit e4a86f5

Please sign in to comment.